ccloud-client-go

A comprehensive Go client library for Confluent Cloud API. This library enables developers to programmatically manage Confluent Cloud resources including Kafka clusters, environments, service accounts, client quotas, connectors, and more.

Features

• Environment Management: Create, list, and delete Confluent Cloud environments
• Kafka Cluster Management: Provision and manage Kafka clusters
• Service Account Management: Create and manage service accounts and API keys
• Client Quota Management: Define and control resource quotas for clients
• Connector Management: Create, configure, monitor, and manage Kafka connectors with lifecycle control
• Schema Registry Integration: Manage schemas and subjects
• RBAC Support: Role-based access control operations
• Cluster Linking: Configure and manage cluster linking
• ACL Management: Control access to Kafka resources

Installation

go get github.com/electric-saw/ccloud-client-go

Quick Start

package main

import (
	"fmt"

	"github.com/electric-saw/ccloud-client-go/ccloud"
)

func main() {
	// Create a client with Basic Auth
	auth := ccloud.BasicAuth{
		Username: "YOUR_API_KEY",
		Password: "YOUR_API_SECRET",
	}

	client := ccloud.NewClient().WithAuth(auth)

	// List environments
	environments, err := client.ListEnvironments(nil)
	if err != nil {
		panic(err)
	}

	fmt.Printf("Found %d environments\n", len(environments.Data))
	for _, env := range environments.Data {
		fmt.Printf("- %s (ID: %s)\n", env.DisplayName, env.Id)
	}
}

Authentication

The library supports API Key authentication:

// Using Basic Auth (API Key & Secret)
auth := ccloud.BasicAuth{
    Username: "YOUR_API_KEY",
    Password: "YOUR_API_SECRET",
}
client := ccloud.NewClient().WithAuth(auth)

Working with Client Quotas

// List client quotas
quotas, err := client.ListClientQuotas(&ccloud.ClientQuotaListOptions{
    Cluster:     "lkc-abc123",
    Environment: "env-xyz789",
})

// Get a specific client quota
quota, err := client.GetClientQuota("cq-12345")

// Create a new client quota
newQuota := &ccloud.ClientQuotaCreateReq{
    DisplayName: "My Client Quota",
    Description: "Quota for test service",
    Throughput: &ccloud.ClientQuotaThroughput{
        IngressByteRate: "1048576", // 1 MB/s
        EgressByteRate:  "1048576", // 1 MB/s
    },
    Cluster: &ccloud.ClientQuotaCluster{
        ID: "lkc-abc123",
    },
    Principals: []ccloud.ClientQuotaPrincipal{
        {ID: "sa-abc123"},
    },
    Environment: &ccloud.ClientQuotaEnvironment{
        ID: "env-xyz789",
    },
}

createdQuota, err := client.CreateClientQuota(newQuota)

// Update a client quota
updateReq := &ccloud.ClientQuotaUpdateReq{
    DisplayName: "Updated Quota Name",
    Throughput: &ccloud.ClientQuotaThroughput{
        IngressByteRate: "2097152", // 2 MB/s
    },
}

updatedQuota, err := client.UpdateClientQuota(quota.ID, updateReq)

// Delete a client quota
err = client.DeleteClientQuota(quota.ID)

Working with Connectors

Creating a Connector

// Create an S3 Sink Connector
s3Config := &ccloud.S3SinkConnectorConfig{
    ConnectorClass:        "S3_SINK",
    Bucket:                "my-s3-bucket",
    AuthenticationMethod:  "IAM Roles",
    ProviderIntegrationId: "pi-12345",
    Topics:                "my-topic",
    InputDataFormat:       "AVRO",
    OutputDataFormat:      "AVRO",
    TasksMax:              "2",
}

connector, err := client.CreateConnector("env-xyz789", "lkc-abc123", "my-s3-connector", s3Config)
if err != nil {
    panic(err)
}

fmt.Printf("Connector created: %s\n", connector.Name)

Managing Connector Lifecycle

// Get connector details
connector, err := client.GetConnector("env-xyz789", "lkc-abc123", "my-s3-connector")

// Get connector status
status, err := client.GetConnectorStatus("env-xyz789", "lkc-abc123", "my-s3-connector")
fmt.Printf("Connector status: %s\n", status.Connector.State)

// Pause a connector
err = client.PauseConnector("env-xyz789", "lkc-abc123", "my-s3-connector")

// Resume a connector
err = client.ResumeConnector("env-xyz789", "lkc-abc123", "my-s3-connector")

// Restart a connector
err = client.RestartConnector("env-xyz789", "lkc-abc123", "my-s3-connector")

// List all connectors
connectors, err := client.ListConnectors("env-xyz789", "lkc-abc123")

// Update connector configuration
newConfig := &ccloud.S3SinkConnectorConfig{
    TasksMax: "4",
}

updatedConnector, err := client.UpdateConnectorConfig("env-xyz789", "lkc-abc123", "my-s3-connector", newConfig)

// Delete a connector
err = client.DeleteConnector("env-xyz789", "lkc-abc123", "my-s3-connector")

Understanding Connector Status

The connector status provides detailed information about the connector and its tasks:

status, err := client.GetConnectorStatus("env-xyz789", "lkc-abc123", "my-s3-connector")

// Check connector state
if status.Connector.State == "RUNNING" {
    fmt.Println("Connector is running")
}

// Check individual task status
for _, task := range status.Tasks {
    fmt.Printf("Task %d: %s\n", task.Id, task.State)
}

Additional Examples

Check the examples directory for more usage examples.

Running Tests

# Run all tests
go test ./...

# Run tests with coverage
go test -coverprofile=coverage.out ./...
go tool cover -html=coverage.out

# Skip integration tests
go test -short ./...

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.