Skip to content

[CIAM-2487] Add warning to KSQL create command #1534

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

Merged
Lucy Fan (lucy-fan) merged 7 commits into from
Nov 21, 2022
Merged

[CIAM-2487] Add warning to KSQL create command #1534

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
553a828
Add warning to KSQL create
lucy-fan Nov 18, 2022
9a573be
Change warning text
lucy-fan Nov 18, 2022
8b6a272
Add warning to test files
lucy-fan Nov 19, 2022
e78fac7
update warning
lucy-fan Nov 19, 2022
254fd2c
add feature flag
lucy-fan Nov 21, 2022
2c0cda1
Add check for SR cluster
lucy-fan Nov 21, 2022
ef28c90
Update variable name
lucy-fan Nov 21, 2022
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
8 changes: 8 additions & 0 deletions internal/cmd/ksql/command_cluster_create.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package ksql
import (
"context"
"fmt"
"os"

schedv1 "github.com/confluentinc/cc-structs/kafka/scheduler/v1"
"github.com/gogo/protobuf/types"
Expand Down Expand Up @@ -104,5 +105,12 @@ func (c *ksqlCommand) create(cmd *cobra.Command, args []string) error {
utils.ErrPrintln(cmd, errors.EndPointNotPopulatedMsg)
}

if os.Getenv("XX_DATAPLANE_3_ENABLE") != "" {
srCluster, _ := c.Context.FetchSchemaRegistryByAccountId(context.Background(), c.EnvironmentId())
if srCluster != nil {
utils.ErrPrintln(cmd, errors.SchemaRegistryRoleBindingRequiredForKsqlWarning)
}
}

return output.DescribeObject(cmd, c.updateKsqlClusterForDescribeAndList(cluster), describeFields, describeHumanRenames, describeStructuredRenames)
}
4 changes: 4 additions & 0 deletions internal/pkg/errors/warning_message.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,4 +48,8 @@ const (
RetentionTimeDiscrepancyWarning = "Retention Time Discrepancy Warning: Topic %q had discrepancies in retention time." +
" Using max: %v. Discrepancies in retention time occur when two cluster configurations have the same topic in a" +
" router configuration, but different retention times. The maximum specified retention time will be used."

// ksql cluster create
SchemaRegistryRoleBindingRequiredForKsqlWarning = "IMPORTANT: Confirm that the users or service accounts that will interact " +
"with this cluster have the required privileges to access Schema Registry."
)
12 changes: 12 additions & 0 deletions test/fixtures/output/ksql/app/create-result-rbac-stage3.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
`confluent ksql app` is deprecated: Use the equivalent `confluent ksql cluster` commands instead.
IMPORTANT: Confirm that the users or service accounts that will interact with this cluster have the required privileges to access Schema Registry.
+-------------------------+--------------------------+
| Id | lksqlc-ksql5 |
| Name | account ksql |
| Topic Prefix | pksqlc-abcde |
| Kafka | lkc-qwert |
| Storage | 101 |
| Endpoint | SASL_SSL://ksql-endpoint |
| Status | PROVISIONING |
| Detailed Processing Log | true |
+-------------------------+--------------------------+
11 changes: 11 additions & 0 deletions test/fixtures/output/ksql/cluster/create-result-rbac-stage3.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
IMPORTANT: Confirm that the users or service accounts that will interact with this cluster have the required privileges to access Schema Registry.
+-------------------------+--------------------------+
| Id | lksqlc-ksql5 |
| Name | account ksql |
| Topic Prefix | pksqlc-abcde |
| Kafka | lkc-qwert |
| Storage | 101 |
| Endpoint | SASL_SSL://ksql-endpoint |
| Status | PROVISIONING |
| Detailed Processing Log | true |
+-------------------------+--------------------------+
2 changes: 2 additions & 0 deletions test/ksql_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ func (s *CLITestSuite) TestKSQL() {
{args: "ksql app create --help", fixture: "ksql/app/create-help.golden"},
{args: "ksql app create test_ksql --cluster lkc-12345", fixture: "ksql/app/create-result-missing-api-key.golden", wantErrCode: 1},
{args: "ksql app create test_ksql --cluster lkc-12345 --api-key key --api-secret secret", fixture: "ksql/app/create-result.golden"},
{args: "ksql app create test_ksql --cluster lkc-12345 --api-key key --api-secret secret", env: []string{"XX_DATAPLANE_3_ENABLE=1"}, fixture: "ksql/app/create-result-rbac-stage3.golden"},
{args: "ksql app create test_ksql_json --cluster lkc-12345 --api-key key --api-secret secret -o json", fixture: "ksql/app/create-result-json.golden"},
{args: "ksql app create test_ksql_yaml --cluster lkc-12345 --api-key key --api-secret secret -o yaml", fixture: "ksql/app/create-result-yaml.golden"},
{args: "ksql app create test_ksql --cluster lkc-processLogFalse --api-key key --api-secret secret --log-exclude-rows", fixture: "ksql/app/create-log-exclude-rows-result.golden"},
Expand All @@ -35,6 +36,7 @@ func (s *CLITestSuite) TestKSQL() {
{args: "ksql cluster create --help", fixture: "ksql/cluster/create-help.golden"},
{args: "ksql cluster create test_ksql --cluster lkc-12345", fixture: "ksql/cluster/create-result-missing-api-key.golden", wantErrCode: 1},
{args: "ksql cluster create test_ksql --cluster lkc-12345 --api-key key --api-secret secret", fixture: "ksql/cluster/create-result.golden"},
{args: "ksql cluster create test_ksql --cluster lkc-12345 --api-key key --api-secret secret", env: []string{"XX_DATAPLANE_3_ENABLE=1"}, fixture: "ksql/cluster/create-result-rbac-stage3.golden"},
{args: "ksql cluster create test_ksql_json --cluster lkc-12345 --api-key key --api-secret secret -o json", fixture: "ksql/cluster/create-result-json.golden"},
{args: "ksql cluster create test_ksql_yaml --cluster lkc-12345 --api-key key --api-secret secret -o yaml", fixture: "ksql/cluster/create-result-yaml.golden"},
{args: "ksql cluster create test_ksql --cluster lkc-processLogFalse --api-key key --api-secret secret --log-exclude-rows", fixture: "ksql/cluster/create-result-log-exclude-rows.golden"},
Expand Down