Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,4 @@ vendor
agents/
.serena/
.envrc
scripts/update-sdk-apiserver.sh
20 changes: 11 additions & 9 deletions docs/tools/streamnative_cloud.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
#### sncloud_context_available_clusters

Display the available Pulsar clusters for the current organization on StreamNative Cloud. This information helps you select the appropriate cluster when setting your context.
Display the context-bindable Pulsar clusters available in the current StreamNative Cloud session. This information helps you select the appropriate cluster before binding the session to cluster-specific tools.

- **sncloud_context_available_clusters**
- No parameters required

You can use `sncloud_context_use_cluster` to change the context to a specific cluster. You will need to ask for user confirmation of the target context cluster if there are multiple clusters available.
You can use `sncloud_context_use_cluster` to bind the current session to a specific Pulsar cluster. You will need to ask for user confirmation of the target cluster if there are multiple clusters available.

---

#### sncloud_context_use_cluster

Set the current context to a specific StreamNative Cloud cluster. Once you set the context, you can use Pulsar and Kafka tools to interact with the cluster.
Bind the current session to a specific StreamNative Cloud cluster. Once the session is bound, you can use Pulsar and Kafka tools that require cluster context.

- **sncloud_context_use_cluster**
- `instanceName` (string, required): The name of the Pulsar instance to use
- `clusterName` (string, required): The name of the Pulsar cluster to use

If you encounter `ContextNotSetErr`, please use `sncloud_context_available_clusters` to list the available clusters and set the context to a specific cluster.
If you encounter `ContextNotSetErr`, use `sncloud_context_available_clusters` to list the available clusters and bind the session to a specific cluster.

---

Expand All @@ -34,7 +34,7 @@ This tool returns a JSON object containing the service account name and organiza

#### sncloud_logs

Display logs of resources in StreamNative Cloud, including Pulsar functions, source connectors, sink connectors, and Kafka Connect connectors. This tool helps debug issues with resources in StreamNative Cloud and works with the current context cluster.
Display logs of resources in StreamNative Cloud, including Pulsar functions, source connectors, sink connectors, and Kafka Connect connectors. This tool helps debug issues with resources in the cluster currently bound to the session.

- **sncloud_logs**
- `component` (string, required): The component type to get logs from
Expand All @@ -56,25 +56,27 @@ Display logs of resources in StreamNative Cloud, including Pulsar functions, sou

#### sncloud_resources_apply

Apply (create or update) StreamNative Cloud resources from JSON definitions. This tool can be used to manage infrastructure resources such as PulsarInstances and PulsarClusters in your StreamNative Cloud organization.
Apply (create or update) StreamNative Cloud resources from JSON definitions. This tool manages infrastructure resources such as Instances, PulsarInstances, PulsarClusters, and KafkaClusters in the organization currently bound to the session.

- **sncloud_resources_apply**
- `json_content` (string, required): The JSON content to apply, defining the resource according to the StreamNative Cloud API schema
- `dry_run` (boolean, optional): If true, only validate the resource without applying it to the server (default: false)

Supported resource types:
- Instance (apiVersion: cloud.streamnative.io/v1alpha1)
- PulsarInstance (apiVersion: cloud.streamnative.io/v1alpha1)
- PulsarCluster (apiVersion: cloud.streamnative.io/v1alpha1)
- KafkaCluster (apiVersion: cloud.streamnative.io/v1alpha1)

---

#### sncloud_resources_delete

Delete StreamNative Cloud resources. This tool removes resources from your StreamNative Cloud organization.
Delete StreamNative Cloud resources. This tool removes resources from the organization currently bound to the session.

- **sncloud_resources_delete**
- `name` (string, required): The name of the resource to delete
- `type` (string, required): The type of the resource to delete
- Options: PulsarInstance, PulsarCluster
- Options: Instance, PulsarInstance, PulsarCluster, KafkaCluster

This is a destructive operation that cannot be undone. Use with caution.
This is a destructive operation that cannot be undone. Use with caution.
349 changes: 349 additions & 0 deletions go.sum

Large diffs are not rendered by default.

375 changes: 375 additions & 0 deletions go.work.sum

Large diffs are not rendered by default.

Loading
Loading