Writing Skills
writing-skills
效率与协作技能,来自 obra/superpowers,查看原文获取完整用途和操作说明。
cloud-provisioning【部署与运维】Provision and operate Elastic Cloud infrastructure: create, connect to, update, and delete Serverless projects (Elasticsearch, Observability, Security); manage traffic filters (IP and AWS PrivateLink network security); and manage the lifecycle of Elastic Cloud Hosted deployments. Use when creating or performing day-2 operations on serverless projects…
独立 GitHub 快照 · 自动分类 · 以原作者文档为准
elastic CLI (>= 0.2) with cloud serverless and cloud hosted support
and network access to the Elastic Cloud API (api.elastic-cloud.com). Serverless
operations apply to Elastic Cloud Serverless; deployment operations apply to Elastic
Cloud Hosted. Depends on a configured Cloud context (see cloud-onboarding).
metadata:
author: elastic
version: 0.3.0
universal: trueProvision and run Elastic Cloud infrastructure through the Cloud API: Serverless projects (create and day-2 operations), traffic filters (network security for those projects), and Elastic Cloud Hosted deployments. For configuring Cloud authentication and managing organization access, use the cloud-onboarding skill.
This skill operates the Elastic Cloud control plane through the elastic CLI. If the
elastic CLI is not installed, tell the user what it is needed for. Do
not guess credentials, bypass the CLI to call the HTTP API directly, or attempt other workarounds.
Control-plane operations authenticate against the Elastic Cloud API (organization scope), not a single stack deployment.
The elastic CLI reads this from its active context, which stores an Elastic Cloud API key in the OS keychain. If a
control-plane call fails with an authentication error, the context is missing or lacks a Cloud API key — instruct the
user to add one, and never ask the user to paste an API key into the chat:
"Configure an Elastic Cloud context for the
elasticCLI, then re-run. Generate an Organization-level key at Elastic Cloud API keys and register it without echoing the secret in chat."
This skill references control-plane operations in HTTP-shorthand form with the cloud: prefix (e.g.,
GET cloud:/api/v1/organizations, POST cloud:/api/v1/serverless/projects/elasticsearch). The
Operations table at the end of this document maps each shorthand to the equivalent elastic cloud
command — always use the CLI rather than calling the HTTP API directly. Discover the organization ID from
GET cloud:/api/v1/organizations; do not ask the user for it.
admin password returned on creation or reset exists solely to create a
scoped API key. Never use admin credentials for ongoing Elasticsearch operations — mint a scoped key first.initializing; wait until initialized before using it.| Type | Description | Included services |
|---|---|---|
elasticsearch | Search, analytics, and vector workloads | Elasticsearch, Kibana |
observability | Logs, metrics, traces, and APM | Elasticsearch, Kibana, APM, OTLP |
security | SIEM, endpoint protection, cloud security | Elasticsearch, Kibana, OTLP |
Map the user's request to the correct type; never silently default — infer from context and confirm, or ask when
ambiguous. "search"/"elasticsearch"/vector search → elasticsearch; "o11y"/logs/metrics/traces/APM → observability;
"SIEM"/detections/endpoint → security.
Tiers and optimization. Elasticsearch: set optimized_for to general_purpose (default) unless the user explicitly
requests vector. Observability: set product_tier to complete (default) or logs_essentials. Security: set
product_types tiers to complete (default) or essentials per product line (security, cloud, endpoint). See
references/api-reference.md for the full request-body schema of each type.
gcp-us-central1), and the tier/optimization for the type — and get explicit confirmation. If the region is
uncertain, list options with GET cloud:/api/v1/serverless/regions first; only regions with
project_creation_enabled: true accept new projects. Region is permanent.POST cloud:/api/v1/serverless/projects/{type} with the confirmed body. Wait for the
initialized phase and persist the returned credentials into a named CLI context (the password goes to the OS
keychain, never to stdout or chat).GET cloud:/api/v1/serverless/projects/{type}/{id}/status until phase is initialized. The Elasticsearch and
Kibana endpoints in the creation response are safe to share; the password is not.POST /_security/api_key (the project's Elasticsearch endpoint), then rely on that key
for all data-plane work. If the elasticsearch-authn skill is available, use it for full key lifecycle handling.Use this when the user asks to query or manage a project not created in the current session. It applies to Elastic Cloud Serverless projects only — if the cluster is self-managed or Elastic Cloud Hosted, use the Hosted deployment workflow or skip. If unsure, ask: "Is your Elasticsearch instance an Elastic Cloud Serverless project?"
GET cloud:/api/v1/serverless/projects/{type}. Match
the user's reference (name or alias). If multiple or none match, present candidates and ask.GET cloud:/api/v1/serverless/projects/{type}/{id} to get
its Elasticsearch and Kibana endpoints, and select or create a CLI context bound to it.GET /_security/_authenticate
(expect "authentication_type": "api_key"). If none works, confirm with the user, reset the admin bootstrap
credentials with POST cloud:/api/v1/serverless/projects/{type}/{id}/_reset-credentials, use the admin password once
to create a scoped key via POST /_security/api_key, persist it to the context, re-verify, and drop the admin
credentials.GET cloud:/api/v1/serverless/projects/{type}.GET cloud:/api/v1/serverless/projects/{type}/{id}.PATCH cloud:/api/v1/serverless/projects/{type}/{id}.POST cloud:/api/v1/serverless/projects/{type}/{id}/_reset-credentials.DELETE cloud:/api/v1/serverless/projects/{type}/{id}.initialized:
POST cloud:/api/v1/serverless/projects/{type}/{id}/_resume.Update fields and their risks. Supported PATCH fields: name, alias, metadata.tags, traffic_filters, and —
for Elasticsearch — search_lake.search_power (28–3000) and search_lake.boost_window (1–180 days); for Security —
data-retention limits.
GET first and include any the user wants to keep.search_power drives cost. Higher values increase VCU consumption. Warn and confirm before raising it (presets:
28 on-demand, 100 performant, 250 high availability).Traffic filters restrict network access to Serverless projects. The Elastic Cloud UI calls this network security;
the Cloud API uses traffic filters (traffic-filters in paths, traffic_filters in project JSON). The two types
are IP filters (type ip, allowlist IPs/CIDRs) and VPC filters (type vpce, AWS PrivateLink endpoint IDs).
Private connectivity in AWS is accepted by default. A VPC filter is only needed to restrict traffic to specific endpoint IDs. If you only need private connectivity (not filtering), create the VPC endpoint and DNS record in AWS — no filter is required. Use
GET cloud:/api/v1/serverless/traffic-filters/metadatato look up the PrivateLink service name for a region before creating the endpoint in AWS.
GET cloud:/api/v1/serverless/traffic-filters (optionally scoped
by region). If a filter already covers the same sources for the same purpose, reuse it — filters are
region-scoped and can attach to many projects.POST cloud:/api/v1/serverless/traffic-filters with the type, region, and rules.
The response contains the generated filter id.PATCH cloud:/api/v1/serverless/projects/{type}/{id} with a traffic_filters array). Provide the complete list
of filter IDs; any ID omitted is disassociated.GET the project to confirm the change took effect.Filter guidance: filters are region-scoped (a filter can only attach to projects in its region). Updating rules
replaces the entire rule set — include all existing rules plus the new one. A filter cannot be deleted while still
associated with a project — disassociate first, then DELETE cloud:/api/v1/serverless/traffic-filters/{id}.
include_by_default auto-attaches a filter to all new projects in the region — use with caution. See
references/traffic-filters.md for the full schemas.
Elastic Cloud Hosted deployments are full stack deployments (Elasticsearch, Kibana, and optional APM/Integrations Server/Enterprise Search) sized from a deployment template, distinct from Serverless projects. Manage their lifecycle through the Cloud API's deployment endpoints.
GET cloud:/api/v1/deployments/templates for the
target region and confirm the template and stack version with the user. Region is permanent.POST cloud:/api/v1/deployments with the resource definition (or a template_id).
The response returns the deployment ID and a one-time elastic user password and endpoints — persist the credentials
into a CLI context (keychain), never to chat.GET cloud:/api/v1/deployments/{id} until healthy, then mint a
scoped Elasticsearch API key via POST /_security/api_key and stop using the bootstrap elastic password. See
references/hosted-deployments.md for the create body and template schema.GET cloud:/api/v1/deployments.GET cloud:/api/v1/deployments/{id}.PUT cloud:/api/v1/deployments/{id}.POST cloud:/api/v1/deployments/{id}/_shutdown.POST cloud:/api/v1/deployments/{id}/_restore.Hosted deployments use their own traffic-filter rulesets, managed separately from the Serverless traffic filters above — do not mix the two. See references/hosted-deployments.md.
"Create a search project called acme-search" — confirm type elasticsearch, present the summary (name
acme-search, region gcp-us-central1, optimized_for general_purpose), and on confirmation call
POST cloud:/api/v1/serverless/projects/elasticsearch, wait for initialized, persist credentials, then create a
scoped API key with POST /_security/api_key.
"List my security projects" — call GET cloud:/api/v1/serverless/projects/security and present the names and IDs;
treat it as a read-only day-2 request.
"Connect to my search project prod-search" — list Elasticsearch projects, match prod-search, GET it for
endpoints, then verify or mint a scoped Elasticsearch API key before any data-plane work.
"Bump search power to 500 on my search project" — warn about the cost increase, confirm, then
PATCH cloud:/api/v1/serverless/projects/elasticsearch/{id} with search_lake.search_power = 500.
"Only allow our office network 203.0.113.0/24 to projects in us-east-1" — list existing filters for us-east-1,
create an ip filter with POST cloud:/api/v1/serverless/traffic-filters (rule source 203.0.113.0/24), then attach
the filter ID to the target projects via PATCH cloud:/api/v1/serverless/projects/{type}/{id}.
"Spin up a hosted deployment in us-east-1" — list templates with GET cloud:/api/v1/deployments/templates, confirm
the template and stack version, then POST cloud:/api/v1/deployments, wait until healthy, and mint a scoped API key.
general_purpose optimization and the complete
tier; only change on explicit request.| HTTP API (shorthand) | elastic CLI command |
|---|---|
GET cloud:/api/v1/serverless/regions | elastic cloud serverless regions list-regions |
POST cloud:/api/v1/serverless/projects/elasticsearch | elastic cloud serverless projects search create --input-file <json> --wait --save-as <ctx> |
POST cloud:/api/v1/serverless/projects/observability | elastic cloud serverless projects observability create --input-file <json> --wait --save-as <ctx> |
POST cloud:/api/v1/serverless/projects/security | elastic cloud serverless projects security create --input-file <json> --wait --save-as <ctx> |
GET cloud:/api/v1/serverless/projects/elasticsearch | elastic cloud serverless projects search list |
GET cloud:/api/v1/serverless/projects/elasticsearch/{id} | elastic cloud serverless projects search get --id <id> |
GET cloud:/api/v1/serverless/projects/elasticsearch/{id}/status | elastic cloud serverless projects search get-status --id <id> |
PATCH cloud:/api/v1/serverless/projects/elasticsearch/{id} | elastic cloud serverless projects search patch --id <id> --input-file <json> |
DELETE cloud:/api/v1/serverless/projects/elasticsearch/{id} | elastic cloud serverless projects search delete --id <id> |
POST cloud:/api/v1/serverless/projects/elasticsearch/{id}/_reset-credentials | elastic cloud serverless projects search reset-credentials --id <id> --save-as <ctx> |
POST cloud:/api/v1/serverless/projects/elasticsearch/{id}/_resume | elastic cloud serverless projects search resume --id <id> |
GET cloud:/api/v1/serverless/traffic-filters | elastic cloud serverless traffic-filters list-traffic-filters --region <region> |
POST cloud:/api/v1/serverless/traffic-filters | elastic cloud serverless traffic-filters create-traffic-filter --input-file <json> |
GET cloud:/api/v1/serverless/traffic-filters/{id} | elastic cloud serverless traffic-filters get-traffic-filter --id <id> |
PATCH cloud:/api/v1/serverless/traffic-filters/{id} | elastic cloud serverless traffic-filters patch-traffic-filter --id <id> --input-file <json> |
DELETE cloud:/api/v1/serverless/traffic-filters/{id} | elastic cloud serverless traffic-filters delete-traffic-filter --id <id> |
GET cloud:/api/v1/serverless/traffic-filters/metadata | elastic cloud serverless traffic-filters get-traffic-filter-metadata --region <region> |
GET cloud:/api/v1/deployments/templates | elastic cloud hosted deployment-templates get-deployment-templates-v2 |
GET cloud:/api/v1/deployments | elastic cloud hosted deployments list-deployments |
POST cloud:/api/v1/deployments | elastic cloud hosted deployments create-deployment --input-file <json> |
GET cloud:/api/v1/deployments/{id} | elastic cloud hosted deployments get-deployment --deployment-id <id> |
PUT cloud:/api/v1/deployments/{id} | elastic cloud hosted deployments update-deployment --deployment-id <id> --input-file <json> |
POST cloud:/api/v1/deployments/{id}/_shutdown | elastic cloud hosted deployments shutdown-deployment --deployment-id <id> |
POST cloud:/api/v1/deployments/{id}/_restore | elastic cloud hosted deployments restore-deployment --deployment-id <id> |
GET /_security/_authenticate | elastic es security authenticate |
POST /_security/api_key | elastic es security create-api-key --input-file <json> |
Use the matching projects observability … / projects security … commands for observability and security project
types.