Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

connectors: Iceberg sink connector guide #811

Merged
merged 1 commit into from
Oct 5, 2023
Merged

connectors: Iceberg sink connector guide #811

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
84 changes: 84 additions & 0 deletions backend/pkg/connector/guide/iceberg_sink.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
// Copyright 2023 Redpanda Data, Inc.
//
// Use of this software is governed by the Business Source License
// included in the file licenses/BSL.md
//
// As of the Change Date specified in that file, in accordance with
// the Business Source License, use of this software will be governed
// by the Apache License, Version 2.0

package guide

import "github.com/redpanda-data/console/backend/pkg/connector/model"

// NewIcebergSinkGuide returns a new guide for Iceberg sink connector.
func NewIcebergSinkGuide(opts ...Option) Guide {
var o Options
for _, opt := range opts {
opt(&o)
}

return &WizardGuide{
className: "io.tabular.iceberg.connect.IcebergSinkConnector",
wizardSteps: []model.ValidationResponseStep{
{
Name: "Topics to export",
Groups: []model.ValidationResponseStepGroup{
{
// No Group name and description here
ConfigKeys: []string{"topics", "topics.regex"},
},
},
},

{
Name: "Connection",
Groups: []model.ValidationResponseStepGroup{
{
ConfigKeys: []string{
"iceberg.catalog.type",
"iceberg.catalog.uri",
"iceberg.catalog.s3.access-key-id",
"iceberg.catalog.s3.secret-access-key",
"iceberg.catalog.client.region",
"iceberg.catalog.s3.path-style-access",
"iceberg.catalog.s3.endpoint",
},
},
},
},

{
Name: "Connector configuration",
Groups: []model.ValidationResponseStepGroup{
{
// No Group name and description here
ConfigKeys: append([]string{
"key.converter",
"key.converter.schemas.enable",
"value.converter",
"value.converter.schemas.enable",
"header.converter",
"iceberg.control.topic",
"iceberg.control.group.id",
"iceberg.catalog",
"iceberg.control.commitIntervalMs",
"iceberg.control.commitThreads",
"iceberg.control.commitTimeoutMs",
"iceberg.tables",
"iceberg.tables.cdcField",
"iceberg.tables.dynamic.enabled",
"iceberg.tables.routeField",
"iceberg.tables.upsertModeEnabled",
"consumer.override.auto.offset.reset",
}, dlq()...),
},
},
},

sizing(),

reviewAndLaunch(),
},
}
}
220 changes: 220 additions & 0 deletions backend/pkg/connector/interceptor/iceberg_sink_hook.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,220 @@
package interceptor

import (
"github.com/redpanda-data/console/backend/pkg/connector/model"
"github.com/redpanda-data/console/backend/pkg/connector/patch"
)

// KafkaConnectToConsoleIcebergSinkHook adds Iceberg sink specific config options
// missing in Validate Kafka Connect response
func KafkaConnectToConsoleIcebergSinkHook(response model.ValidationResponse, config map[string]any) model.ValidationResponse {
response.Configs = append(response.Configs, model.ConfigDefinition{
Definition: model.ConfigDefinitionKey{
Name: "iceberg.catalog.type",
Type: "STRING",
DefaultValue: "",
Importance: model.ConfigDefinitionImportanceHigh,
Required: false,
DisplayName: "Iceberg catalog type",
Documentation: "To set the catalog type. For other catalog types, you need to instead set 'iceberg.catalog.catalog-impl' to the name of the catalog class",
Dependents: []string{},
},
Value: model.ConfigDefinitionValue{
Name: "iceberg.catalog.type",
Value: "rest",
RecommendedValues: []string{},
Visible: true,
Errors: []string{},
},
Metadata: model.ConfigDefinitionMetadata{
ComponentType: model.ComponentRadioGroup,
RecommendedValues: []model.RecommendedValueWithMetadata{
{Value: "rest", DisplayName: "REST"},
{Value: "hive", DisplayName: "HIVE"},
{Value: "hadoop", DisplayName: "HADOOP"},
},
},
},
model.ConfigDefinition{
Definition: model.ConfigDefinitionKey{
Name: "iceberg.catalog.uri",
Type: "STRING",
DefaultValue: "",
Importance: model.ConfigDefinitionImportanceHigh,
Required: false,
DisplayName: "Iceberg catalog uri",
Documentation: "Iceberg REST catalog uri",
Dependents: []string{},
},
Value: model.ConfigDefinitionValue{
Name: "iceberg.catalog.uri",
Value: "",
RecommendedValues: []string{},
Visible: isRestCatalogType(response.Configs),
Errors: []string{},
},
},
model.ConfigDefinition{
Definition: model.ConfigDefinitionKey{
Name: "iceberg.catalog.s3.secret-access-key",
Type: "PASSWORD",
DefaultValue: "",
Importance: model.ConfigDefinitionImportanceHigh,
Required: false,
DisplayName: "Iceberg REST catalog S3 Secret Access Key",
Documentation: "Use for Iceberg REST catalog type. Use JSON configuration for other catalog types",
Dependents: []string{},
},
Value: model.ConfigDefinitionValue{
Name: "iceberg.catalog.s3.secret-access-key",
Value: "",
RecommendedValues: []string{},
Visible: isRestCatalogType(response.Configs),
Errors: []string{},
},
},
model.ConfigDefinition{
Definition: model.ConfigDefinitionKey{
Name: "iceberg.catalog.s3.access-key-id",
Type: "PASSWORD",
DefaultValue: "",
Importance: model.ConfigDefinitionImportanceHigh,
Required: false,
DisplayName: "Iceberg REST catalog S3 Access Key ID",
Documentation: "Use for Iceberg REST catalog type. Use JSON configuration for other catalog types",
Dependents: []string{},
},
Value: model.ConfigDefinitionValue{
Name: "iceberg.catalog.s3.access-key-id",
Value: "",
RecommendedValues: []string{},
Visible: isRestCatalogType(response.Configs),
Errors: []string{},
},
},
model.ConfigDefinition{
Definition: model.ConfigDefinitionKey{
Name: "iceberg.catalog.s3.endpoint",
Type: "STRING",
DefaultValue: "",
Importance: model.ConfigDefinitionImportanceMedium,
Required: false,
DisplayName: "Iceberg REST catalog S3 endpoint",
Documentation: "Use for Iceberg REST catalog type. Use JSON configuration for other catalog types",
Dependents: []string{},
},
Value: model.ConfigDefinitionValue{
Name: "iceberg.catalog.s3.endpoint",
Value: "",
RecommendedValues: []string{},
Visible: isRestCatalogType(response.Configs),
Errors: []string{},
},
},
model.ConfigDefinition{
Definition: model.ConfigDefinitionKey{
Name: "iceberg.catalog.s3.path-style-access",
Type: "BOOLEAN",
DefaultValue: "",
Importance: model.ConfigDefinitionImportanceHigh,
Required: false,
DisplayName: "Iceberg REST catalog S3 path style access",
Documentation: "Use for Iceberg REST catalog type. Use JSON configuration for other catalog types",
Dependents: []string{},
},
Value: model.ConfigDefinitionValue{
Name: "iceberg.catalog.s3.path-style-access",
Value: "",
RecommendedValues: []string{},
Visible: true,
Errors: []string{},
},
},
model.ConfigDefinition{
Definition: model.ConfigDefinitionKey{
Name: "iceberg.catalog.client.region",
Type: "STRING",
DefaultValue: "",
Importance: model.ConfigDefinitionImportanceHigh,
Required: false,
DisplayName: "Iceberg REST catalog client region",
Documentation: "Use for Iceberg REST catalog type. Use JSON configuration for other catalog types",
Dependents: []string{},
},
Value: model.ConfigDefinitionValue{
Name: "iceberg.catalog.client.region",
Value: "us-east-1",
RecommendedValues: patch.AwsRegions,
Visible: true,
Errors: []string{},
},
},
model.ConfigDefinition{
Definition: model.ConfigDefinitionKey{
Name: "iceberg.catalog.credential",
Type: "STRING",
DefaultValue: "",
Importance: model.ConfigDefinitionImportanceHigh,
Required: false,
DisplayName: "Iceberg catalog credential",
Documentation: "Iceberg catalog credential",
Dependents: []string{},
},
Value: model.ConfigDefinitionValue{
Name: "iceberg.catalog.credential",
Value: "",
RecommendedValues: []string{},
Visible: true,
Errors: []string{},
},
},
model.ConfigDefinition{
Definition: model.ConfigDefinitionKey{
Name: "iceberg.catalog.warehouse",
Type: "STRING",
DefaultValue: "",
Importance: model.ConfigDefinitionImportanceHigh,
Required: false,
DisplayName: "Iceberg catalog warehouse",
Dependents: []string{},
},
Value: model.ConfigDefinitionValue{
Name: "iceberg.catalog.warehouse",
Value: "",
RecommendedValues: []string{},
Visible: true,
Errors: []string{},
},
},
model.ConfigDefinition{
Definition: model.ConfigDefinitionKey{
Name: "iceberg.catalog.uri",
Type: "STRING",
DefaultValue: "",
Importance: model.ConfigDefinitionImportanceHigh,
Required: false,
DisplayName: "Iceberg REST catalog URI",
Documentation: "Use for Iceberg REST catalog type. Use JSON configuration for other catalog types",
Dependents: []string{},
},
Value: model.ConfigDefinitionValue{
Name: "iceberg.catalog.uri",
Value: "",
RecommendedValues: []string{},
Visible: isRestCatalogType(response.Configs),
Errors: []string{},
},
},
)

return KafkaConnectToConsoleJSONSchemaHook(response, config)
}

func isRestCatalogType(configs []model.ConfigDefinition) bool {
for _, config := range configs {
if config.Value.Name == "iceberg.catalog.type" {
return config.Value.Value == "rest"
}
}
return true
}
2 changes: 2 additions & 0 deletions backend/pkg/connector/interceptor/interceptor.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ func CommunityPatches() []patch.ConfigPatch {
patch.NewConfigPatchJdbcSink(),
patch.NewConfigPatchJdbcSource(),
patch.NewConfigPatchHTTPSource(),
patch.NewConfigPatchIcebergSink(),
patch.NewConfigPatchMirrorSource(),
patch.NewConfigPatchMirrorHeartbeat(),
patch.NewConfigPatchMongoDB(),
Expand All @@ -81,6 +82,7 @@ func CommunityGuides(opts ...guide.Option) []guide.Guide {
),
guide.NewDebeziumMySQLGuide(guide.WithKafkaConnectValidateToConsoleHookFn(KafkaConnectToConsoleDebeziumMysqlSourceHook),
guide.WithKafkaConnectValidateToConsoleHookFn(KafkaConnectToConsoleCloudEventsConverterHook)),
guide.NewIcebergSinkGuide(guide.WithKafkaConnectValidateToConsoleHookFn(KafkaConnectToConsoleIcebergSinkHook)),
guide.NewSnowflakeSinkGuide(guide.WithKafkaConnectValidateToConsoleHookFn(KafkaConnectToConsoleSnowflakeHook)),
guide.NewBigQuerySinkGuide(guide.WithConsoleToKafkaConnectHookFn(ConsoleToKafkaConnectBigQueryHook),
guide.WithKafkaConnectValidateToConsoleHookFn(KafkaConnectToConsoleJSONSchemaHook)),
Expand Down
6 changes: 3 additions & 3 deletions backend/pkg/connector/patch/http_source.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,15 @@ import (
)

// ConfigPatchHTTPSource is a config patch that includes changes that shall be applied to the
// BigQuery source connector.
// HTTP source connector.
type ConfigPatchHTTPSource struct {
ConfigurationKeySelector IncludeExcludeSelector
ConnectorClassSelector IncludeExcludeSelector
}

var _ ConfigPatch = (*ConfigPatchBigQuery)(nil)
var _ ConfigPatch = (*ConfigPatchHTTPSource)(nil)

// NewConfigPatchHTTPSource returns a new Patch for the BigQuery source connector.
// NewConfigPatchHTTPSource returns a new Patch for the HTTP source connector.
func NewConfigPatchHTTPSource() *ConfigPatchHTTPSource {
return &ConfigPatchHTTPSource{
ConfigurationKeySelector: IncludeExcludeSelector{
Expand Down
Loading