Opensearch logo

Opensearch

OrganizationPopular
kubesphere
opensearch

Use when installing or configuring the OpenSearch extension for KubeSphere, which provides distributed search and analytics engine for storing logs, events, auditing, and notification history

Overview

Publisherkubesphere
Repositorykubesphere
Skill nameopensearch
Stars
17.1K
Forks
2.8K
Bundled files
Instructions only
Links
  • Markdown instructions

    A SKILL.md file the model loads on demand, so it only costs tokens when a request actually matches.

  • Works with any LLM

    AI skills are plain Markdown, not provider-specific code, so this works with GPT, Claude, Gemini, Grok, or a local model.

  • Self-contained

    Everything the model needs lives in the instructions — no extra files to sync.

  • Open source

    Published by kubesphere on GitHub. Read the source before you install it.

Installation

Install the Opensearch AI skill in TypingMind to use it with any LLM, or drop it into another agent that reads SKILL.md.

1

Install in TypingMind

TypingMind installs a skill straight from its GitHub folder — it reads SKILL.md, bundles the resource files, and stores the result locally.

  1. Open the app and go to Plugins → Skills.
  2. Choose "Install from GitHub".
  3. Paste the skill folder URL below and confirm.
  4. Enable the skill in any chat where you want it available.
Plugins → Skills → Add skill → From GitHub URL, then paste the folder URL and press Continue.
2

Install in another agent

Any agent that reads the Agent Skills format can use this skill — copy the folder into that agent's skills directory.

Claude Code — .claude/skills
git clone --depth 1 https://github.com/kubesphere/kubesphere.git /tmp/kubesphere
mkdir -p .claude/skills
cp -r /tmp/kubesphere/skills/opensearch .claude/skills/opensearch
Restart Claude Code after copying so it picks up the new skill.

Use it in TypingMind

Enable Opensearch in any TypingMind chat and the model takes it from there. Its name and description sit in the system prompt, and the moment a request matches, the model loads the full instructions itself — you never invoke it by hand, and it costs no tokens until it is actually used.

The model loads Opensearch on its own as soon as a request matches it.

Works with any AI model

AI skills are plain Markdown instructions rather than provider-specific code, so Opensearch is not tied to the model it was written for. Install it once in TypingMind and use it with GPT-5, Claude, Gemini, Grok, DeepSeek, Mistral, Llama, or a local model you run yourself — all on your own API keys.

  • Loaded only when it is needed

    The system prompt carries just the name and description. The instructions are fetched on the first matching request, so an idle skill costs nothing.

  • Switch models mid-chat

    Because the skill is instructions rather than code, changing model does not break it — the next model reads the same SKILL.md.

Skill instructions

This is the SKILL.md content the model loads. Read it before installing — a skill is instructions your model will follow.

OpenSearch Extension

Overview

OpenSearch is a distributed search and analytics engine built into the KubeSphere WizTelemetry Observability Platform. It is used to store, search, and analyze observability data including logs, auditing events, K8s events, and notification history.

When to Use

  • Installing OpenSearch cluster for KubeSphere observability extensions
  • Configuring OpenSearch storage for logging, events, auditing, and notifications
  • Managing OpenSearch Dashboard and Curator components

Components

ComponentDescriptionDefault
opensearch-masterMaster node for cluster coordination1 replica
opensearch-dataData nodes for storing indices3 replicas
opensearch-dashboardsWeb UI for visualizing datadisabled
opensearch-curatorScheduled task to clean old indicesenabled

Prerequisites

Check Installation Status

bash
# Check if OpenSearch is installed
kubectl get installplan opensearch -o jsonpath='{.spec.enabled}'

# Get installed version
kubectl get extension opensearch -o jsonpath='{.status.installedVersion}'

# Get target clusters
kubectl get installplan opensearch -o jsonpath='{.spec.clusterScheduling.placement.clusters}'

Returns:

  • "true" - installed and enabled
  • "false" - installed but disabled
  • Empty/Error - not installed

Get Available Clusters

bash
kubectl get clusters -o jsonpath='{.items[*].metadata.name}'

Confirm Target Clusters (MUST DO)

⚠️ CRITICAL: Do Not guess.

⚠️ CRITICAL: DO NOT proceed until target clusters are determined.

  • If user explicitly specified target clusters in the request → Use those clusters directly
  • If user did NOT specify target clusters → You MUST ask user to confirm which clusters to deploy to

Ask user (if not specified):

Available clusters: host, dev
Which clusters do you want to deploy OpenSearch to?

Get Latest Version

MUST do this to get the latest version:

bash
kubectl get extensionversions -l kubesphere.io/extension-ref=opensearch -o jsonpath='{range .items[*]}{.spec.version}{"\n"}{end}' | sort -V | tail -1

Installation

⚠️ CRITICAL: InstallPlan metadata.name MUST be opensearch. DO NOT use any other name.

Use the latest version obtained from "Get Latest Version" step.

Minimal Installation

yaml
apiVersion: kubesphere.io/v1alpha1
kind: InstallPlan
metadata:
  name: opensearch
spec:
  extension:
    name: opensearch
    version: <VERSION>  # From Get Latest Version step
  enabled: true
  upgradeStrategy: Manual
  clusterScheduling:
    placement:
      clusters:
        - host

With OpenSearch Dashboard

yaml
apiVersion: kubesphere.io/v1alpha1
kind: InstallPlan
metadata:
  name: opensearch
spec:
  extension:
    name: opensearch
    version: <VERSION>  # From Get Latest Version step
  enabled: true
  upgradeStrategy: Manual
  config: |
    opensearch-dashboards:
      enabled: true
  clusterScheduling:
    placement:
      clusters:
        - host

Disable Curator

yaml
apiVersion: kubesphere.io/v1alpha1
kind: InstallPlan
metadata:
  name: opensearch
spec:
  extension:
    name: opensearch
    version: <VERSION>  # From Get Latest Version step
  enabled: true
  upgradeStrategy: Manual
  config: |
    opensearch-curator:
      enabled: false
  clusterScheduling:
    placement:
      clusters:
        - host

Configuration

Parameters

ParameterTypeDefaultDescription
opensearch-master.replicasint1Number of master nodes
opensearch-master.opensearchJavaOptsstring"-Xmx512M -Xms512M"JVM options
opensearch-master.resourcesobject-Resource limits/requests
opensearch-data.replicasint3Number of data nodes
opensearch-data.opensearchJavaOptsstring"-Xmx1536M -Xms1536M"JVM options
opensearch-data.resourcesobject-Resource limits/requests
opensearch-data.service.typestringNodePortService type
opensearch-data.service.nodePortint30920NodePort for external access
opensearch-dashboards.enabledboolfalseEnable OpenSearch Dashboards
opensearch-curator.enabledbooltrueEnable index cleanup job

Resource Configuration

yaml
opensearch-master:
  replicas: 1
  opensearchJavaOpts: "-Xmx512M -Xms512M"
  resources:
    requests:
      cpu: "100m"
      memory: "512Mi"
    limits:
      cpu: "500m"
      memory: "1Gi"

opensearch-data:
  replicas: 3
  opensearchJavaOpts: "-Xmx2048M -Xms2048M"
  resources:
    requests:
      cpu: "200m"
      memory: "2Gi"
    limits:
      cpu: "2000m"
      memory: "4Gi"
  persistence:
    size: 50Gi
    storageClass: "local-volume"

Operations

Access Target Cluster

⚠️ CRITICAL: You MUST access the target cluster BEFORE checking status or running any kubectl commands below.

DO NOT run kubectl commands without using the target cluster kubeconfig ✅ MUST run: kubectl --kubeconfig=/tmp/<cluster>-kubeconfig ...

Checklist (must complete before any operation):

  • 1. Find target clusters:

    bash
    kubectl get installplan opensearch -o jsonpath='{.spec.clusterScheduling.placement.clusters}'
  • 2. Get cluster kubeconfig:

    bash
    kubectl get cluster <cluster-name> -o jsonpath='{.spec.connection.kubeconfig}' | base64 -d > /tmp/<cluster-name>-kubeconfig
  • 3. Use this kubeconfig for ALL subsequent commands

Note: Replace <cluster-name> with the actual cluster name. Use spec.connection.kubeconfig for imported clusters.

Check Status

⚠️ REQUIRED: Complete Access Target Cluster checklist FIRST

bash
# Extension status
kubectl --kubeconfig=/tmp/<cluster>-kubeconfig get extension opensearch

# InstallPlan status
kubectl --kubeconfig=/tmp/<cluster>-kubeconfig get installplan opensearch

Get Pods

⚠️ REQUIRED: Complete Access Target Cluster checklist FIRST

bash
# All pods
kubectl --kubeconfig=/tmp/<cluster>-kubeconfig get pods -n kubesphere-logging-system -l app.kubernetes.io/instance=opensearch-agent

# By component
kubectl --kubeconfig=/tmp/<cluster>-kubeconfig get pods -n kubesphere-logging-system -l app.kubernetes.io/name=opensearch-master
kubectl --kubeconfig=/tmp/<cluster>-kubeconfig get pods -n kubesphere-logging-system -l app.kubernetes.io/name=opensearch-data

# Status
kubectl --kubeconfig=/tmp/<cluster>-kubeconfig get pods -n kubesphere-logging-system -l app.kubernetes.io/instance=opensearch-agent -o wide

External Endpoint

⚠️ REQUIRED: Complete Access Target Cluster checklist FIRST

OpenSearch uses NodePort (default: 30920) to expose service externally.

bash
# Get NodePort service
kubectl --kubeconfig=/tmp/<cluster>-kubeconfig get svc -n kubesphere-logging-system opensearch-cluster-data

# Get node IP
kubectl --kubeconfig=/tmp/<cluster>-kubeconfig get nodes -o jsonpath='{.items[0].status.addresses[?(@.type=="InternalIP")].address}'

# Access OpenSearch externally
# URL: https://<node-ip>:30920
curl -k -u admin:admin "https://<node-ip>:30920/_cluster/health"

Output Contract (For Other Skills)

⚠️ This section defines what information this skill provides to other skills

When OpenSearch is successfully deployed, other skills can retrieve:

FieldExample ValueDescription
endpointhttps://127.0.0.1:30920Full URL for Vector sink
nodePort30920NodePort number
nodeIP127.0.0.1Node internal IP
auth.useradminDefault username
auth.passwordadminDefault password

How other skills should get this info:

  1. Find which cluster OpenSearch was deployed to:

    bash
    kubectl get installplan opensearch -o jsonpath='{.spec.clusterScheduling.placement.clusters}'
  2. Get cluster kubeconfig:

    bash
    kubectl get cluster <cluster-name> -o jsonpath='{.spec.connection.kubeconfig}' | base64 -d > /tmp/<cluster-name>-kubeconfig
  3. Get OpenSearch endpoint:

    bash
    # NodePort
    NODE_PORT=$(kubectl --kubeconfig=/tmp/<cluster>-kubeconfig get svc -n kubesphere-logging-system opensearch-cluster-data -o jsonpath='{.spec.ports[?(@.port==9200)].nodePort}')
    
    # Node IP
    NODE_IP=$(kubectl --kubeconfig=/tmp/<cluster>-kubeconfig get nodes -o jsonpath='{.items[0].status.addresses[?(@.type=="InternalIP")].address}')
    
    # Full endpoint
    echo "https://${NODE_IP}:${NODE_PORT}"

Update Configuration

yaml
apiVersion: kubesphere.io/v1alpha1
kind: InstallPlan
metadata:
  name: opensearch
spec:
  extension:
    name: opensearch
    version: <VERSION>  # From Get Latest Version step
  enabled: true
  upgradeStrategy: Manual
  config: |
    opensearch-data:
      replicas: 5
      opensearchJavaOpts: "-Xmx4096M -Xms4096M"
    opensearch-dashboards:
      enabled: true
  clusterScheduling:
    placement:
      clusters:
        - host

Uninstall

Uninstall from all clusters:

bash
kubectl delete installplan opensearch

Uninstall from specific cluster:

To remove OpenSearch from a specific cluster, update the InstallPlan by removing that cluster from clusterScheduling.placement.clusters:

yaml
apiVersion: kubesphere.io/v1alpha1
kind: InstallPlan
metadata:
  name: opensearch
spec:
  extension:
    name: opensearch
    version: <VERSION>
  enabled: true
  upgradeStrategy: Manual
  config: |
    opensearch-data:
      replicas: 3
  clusterScheduling:
    placement:
      clusters:
        - <REMAINING_CLUSTERS>  # Remove the cluster you want to uninstall from

Troubleshooting

⚠️ REQUIRED: Complete Access Target Cluster checklist FIRST

Pod Issues

bash
kubectl --kubeconfig=/tmp/<cluster>-kubeconfig get pods -n kubesphere-logging-system -l app.kubernetes.io/instance=opensearch-agent

# Pod events
kubectl --kubeconfig=/tmp/<cluster>-kubeconfig describe pods -n kubesphere-logging-system -l app.kubernetes.io/instance=opensearch-agent

OpenSearch Health

⚠️ REQUIRED: Complete Access Target Cluster checklist FIRST

bash
# Cluster health
curl -k -u admin:admin "https://<node-ip>:30920/_cluster/health"

# List indices
curl -k -u admin:admin "https://<node-ip>:30920/_cat/indices"

Common Issues

IssueSolution
Pods not startingCheck node resources and storage availability
Out of memoryIncrease JVM heap size
Cannot connectCheck NodePort firewall rules
Index storage fullIncrease PVC size or enable Curator

Notes

  1. Resource Requirements: OpenSearch requires significant CPU and memory
  2. Storage: Data nodes use persistent storage
  3. NodePort: Default port is 30920
  4. Multi-cluster: Can be deployed to specific clusters

Frequently asked questions

What does the Opensearch AI skill do?

Use when installing or configuring the OpenSearch extension for KubeSphere, which provides distributed search and analytics engine for storing logs, events, auditing, and notification history

Why use Opensearch on TypingMind?

Because you install it once and use it with any model. Opensearch is plain Markdown rather than provider-specific code, so the same skill runs on GPT-5, Claude, Gemini, Grok, or a local model — and you can switch model mid-chat without it breaking. TypingMind runs on your own API keys, so you pay providers directly instead of a per-seat subscription, and your skills and chats stay in your own storage.

How do I install Opensearch in TypingMind?

Open Plugins → Skills → Install from GitHub in TypingMind and paste https://github.com/kubesphere/kubesphere/tree/master/skills/opensearch. TypingMind reads its SKILL.md and installs it as a skill you can enable per chat.

Which AI models can use Opensearch?

Any model you connect in TypingMind. AI skills are plain Markdown instructions rather than provider-specific code, so GPT, Claude, Gemini, Grok, and local models can all load this skill when a request matches it.

How many AI models can I use with Opensearch?

As many as you like. As long as a model supports skills, you can use Opensearch with it — GPT, Claude, Gemini, Grok, DeepSeek, Mistral, Llama and more — all on TypingMind with your own API keys.

Is the Opensearch AI skill free?

It is published on GitHub by kubesphere. Check the repository for licensing terms. You only pay your own AI provider for the tokens you use.

What are AI skills?

An AI skill is a reusable instruction bundle that teaches an AI model how to do one specific task. It follows the open Agent Skills format: a SKILL.md file with a name and description, plus any scripts, templates or reference files the model may need. The model reads the instructions only when your request matches the skill, so an installed skill costs nothing until it is used.

How are AI skills different from plugins or MCP servers?

A plugin or MCP server gives a model new tools to call — code that runs somewhere and returns a result. An AI skill gives the model knowledge and process instead: how to approach a task, which steps to follow, what good output looks like. Skills are plain Markdown, so they need no server, no API key and no runtime, and they work with any model.

View all

Set up your own AI workspace now

Get notified about new features and future giveaways by subscribing to our newsletter 👇