diff --git a/docs/commands/rhoas.md b/docs/commands/rhoas.md index 1492c1a021..ebe32ebd49 100644 --- a/docs/commands/rhoas.md +++ b/docs/commands/rhoas.md @@ -39,7 +39,7 @@ $ rhoas cluster connect * [rhoas authtoken](rhoas_authtoken.md) - Output the current token * [rhoas cluster](rhoas_cluster.md) - View and perform operations on your Kubernetes or OpenShift cluster * [rhoas completion](rhoas_completion.md) - Install command completion for your shell (bash, zsh, fish or powershell) -* [rhoas connector](rhoas_connector.md) - Connectors instance commands +* [rhoas connector](rhoas_connector.md) - Connectors commands * [rhoas context](rhoas_context.md) - Group, share and manage your rhoas services * [rhoas generate-config](rhoas_generate-config.md) - Generate configurations for the service context * [rhoas kafka](rhoas_kafka.md) - Create, view, use, and manage your Kafka instances diff --git a/docs/commands/rhoas_connector.md b/docs/commands/rhoas_connector.md index 5874c663aa..caea3394c8 100644 --- a/docs/commands/rhoas_connector.md +++ b/docs/commands/rhoas_connector.md @@ -1,43 +1,40 @@ ## rhoas connector -Connectors instance commands +Connectors commands ### Synopsis -With Red Hat OpenShift Connectors, you can create and configure connections between Red Hat OpenShift Streams for Apache Kafka and third-party systems. You can configure Connectors that produce data (data source Connectors) and Connectors that specify where to send data (data sink Connectors). - -A Connectors instance is an instance of a one of the supported Connectors. -Use the "connector" command to create, delete, and view a list of Connectors instances. +With Red Hat OpenShift Connectors, you can create and configure connections between Red Hat OpenShift Streams for Apache Kafka and third-party systems. You can configure Connectors that retrieve data (data source Connectors) and Connectors that specify where to send data (data sink Connectors). ### Examples ``` -# List of Connectors instances -rhoas connector list +# List all connector types +rhoas connector type list -# Create a Connectors instance -rhoas connector create --file=myconnector.json +# Build a Connectors configuration file named "my_aws_lambda_connector.json" that is based on the "aws_lambda_sink_0.1" connector type +rhoas connector build --name=my_aws_lambda_connector --type=--type=aws_lambda_sink_0.1 -# Create a Connectors instance from stdin -cat myconnector.json | rhoas connector create +# Create a Connectors instance by specifying a configuration file +rhoas connector create --file=myconnector.json -# Update a Connectors instance +# Update an existing Connectors instance by specifying a configuration file rhoas connector update --id=my-connector --file=myconnector.json -# Update a Connectors instance from stdin -cat myconnector.json | rhoas connector update - -# Delete a Connectors instance with ID c9b71ucotd37bufoamkg -rhoas connector delete --id=c9b71ucotd37bufoamkg +# List of Connectors instances +rhoas connector list -# Start the Connectors instance with ID c9b71ucotd37bufoamkg -rhoas connector start --id=c9b71ucotd37bufoamkg +# Start the Connectors instance with ID my-connector +rhoas connector start --id=my-connector # Stop the current Connectors instance rhoas connector stop +# Delete a Connectors instance with ID my-connector +rhoas connector delete --id=my-connector + ``` ### Options inherited from parent commands @@ -59,7 +56,7 @@ rhoas connector stop * [rhoas connector namespace](rhoas_connector_namespace.md) - Connectors namespace commands * [rhoas connector start](rhoas_connector_start.md) - Start a Connectors instance * [rhoas connector stop](rhoas_connector_stop.md) - Stop a Connectors instance -* [rhoas connector type](rhoas_connector_type.md) - List and get details of different connector types +* [rhoas connector type](rhoas_connector_type.md) - List and get details of the different connector types * [rhoas connector update](rhoas_connector_update.md) - Update a Connectors instance * [rhoas connector use](rhoas_connector_use.md) - Set the current Connectors instance diff --git a/docs/commands/rhoas_connector_build.md b/docs/commands/rhoas_connector_build.md index 5526a04791..152b73acb6 100644 --- a/docs/commands/rhoas_connector_build.md +++ b/docs/commands/rhoas_connector_build.md @@ -4,8 +4,10 @@ Build a Connectors instance ### Synopsis -Command builds specficication for Connector -instance that can be later created using create command. +Build a configuration file by specifying a connector type. +For a list of available connector types, use the "connector type list" command. + +After you build a configuration file, you can create a Connectors instance by using the "connector create" command and providing the name of the configuration file that you built. ``` @@ -15,24 +17,22 @@ rhoas connector build [flags] ### Examples ``` -# Build a Connectors instance +# Build a Connectors configuration file based on the "aws_lambda_sink_0.1" connector type. The default configuration file name is "connector.json" rhoas connector build --type=--type=aws_lambda_sink_0.1 -# Build a Connectors instance with a name of my_connector -rhoas connector build --name=my_connector --type=--type=aws_lambda_sink_0.1 - -cat myconnector.json | rhoas connector create +# Build a Connectors configuration file named "my_aws_lambda_connector.json" that is based on the "aws_lambda_sink_0.1" connector type +rhoas connector build --name=my_aws_lambda_connector --type=--type=aws_lambda_sink_0.1 ``` ### Options ``` - --name string name of the connector + --name string The name of the connector type that was used to build a configuration file -o, --output string Specify the output format. Choose from: "json", "yaml", "yml" - --output-file string filename of the connector specification file - --overwrite should overwrite file if exist - --type string Connector type (id of the connector) + --output-file string The filename of the connector configuration file + --overwrite Overwrite the file if it aready exists + --type string The type of the connector in the catalog (the same as the ID value for the connector in the catalog) ``` ### Options inherited from parent commands @@ -44,5 +44,5 @@ cat myconnector.json | rhoas connector create ### SEE ALSO -* [rhoas connector](rhoas_connector.md) - Connectors instance commands +* [rhoas connector](rhoas_connector.md) - Connectors commands diff --git a/docs/commands/rhoas_connector_cluster.md b/docs/commands/rhoas_connector_cluster.md index cc4e1a902b..10c4db109a 100644 --- a/docs/commands/rhoas_connector_cluster.md +++ b/docs/commands/rhoas_connector_cluster.md @@ -6,6 +6,7 @@ Create, delete, and list Connectors clusters A Connectors cluster is an OpenShift Dedicated instance for deploying your Connectors instances. Use the "connector cluster" command to create, delete, and view a list of Connectors clusters. + ### Examples ``` @@ -29,7 +30,7 @@ rhoas connector cluster list ### SEE ALSO -* [rhoas connector](rhoas_connector.md) - Connectors instance commands +* [rhoas connector](rhoas_connector.md) - Connectors commands * [rhoas connector cluster addon-parameters](rhoas_connector_cluster_addon-parameters.md) - Get Connectors add-on parameters * [rhoas connector cluster create](rhoas_connector_cluster_create.md) - Create a Connectors cluster * [rhoas connector cluster delete](rhoas_connector_cluster_delete.md) - Delete a Connectors cluster diff --git a/docs/commands/rhoas_connector_cluster_create.md b/docs/commands/rhoas_connector_cluster_create.md index 787daa22d4..c619c9318c 100644 --- a/docs/commands/rhoas_connector_cluster_create.md +++ b/docs/commands/rhoas_connector_cluster_create.md @@ -4,7 +4,7 @@ Create a Connectors cluster ### Synopsis -Create a Connectors cluster and specify its name. You must be an org adminastrator for this to be successful +Create a Connectors cluster and specify its name. You must have administrator access to run this command. ``` rhoas connector cluster create [flags] diff --git a/docs/commands/rhoas_connector_cluster_delete.md b/docs/commands/rhoas_connector_cluster_delete.md index 2de10e6064..98c0c9531f 100644 --- a/docs/commands/rhoas_connector_cluster_delete.md +++ b/docs/commands/rhoas_connector_cluster_delete.md @@ -4,7 +4,7 @@ Delete a Connectors cluster ### Synopsis -Delete a Connectors cluster by specifying its cluster ID. Use the "connector cluster list" command to see a list of all Connectors clusters and their ID values.' +Delete a Connectors cluster by specifying its cluster ID. To see a list of all Connectors clusters and their ID values, use the "connector cluster list" command. ``` diff --git a/docs/commands/rhoas_connector_create.md b/docs/commands/rhoas_connector_create.md index 60067f807e..e2863f4de6 100644 --- a/docs/commands/rhoas_connector_create.md +++ b/docs/commands/rhoas_connector_create.md @@ -4,7 +4,13 @@ Create a Connectors instance ### Synopsis -Create a Connectors instance +Create a Connectors instance. + +A Connectors instance is an instance of a one of the supported Connectors. +Use the "connector" command to create, delete, and view a list of Connectors instances. + +Before you create a Connectors instance, you must use the "connector build" command to create a configuration file for the type of connector that you want to create. + ``` rhoas connector create [flags] @@ -13,7 +19,7 @@ rhoas connector create [flags] ### Examples ``` -# Create a Connectors instance +# Create a Connectors instance by specifying a configuration file rhoas connector create --file=myconnector.json ``` @@ -21,11 +27,11 @@ rhoas connector create --file=myconnector.json ### Options ``` - --create-service-account If set, the connector will be created with the newly specified service account + --create-service-account If set, the connector is created with the specified service account -f, --file string Location of the Connectors JSON file that describes the connector - --kafka string Id of the kafka instance (by default kafka instance from context would be used) - --name string Override name of the connector (by default name in the connector spec would be used) - --namespace string Id of the namespace for the connector (by default namespace from context would be used) + --kafka string ID of the Kafka instance (the default is the Kafka instance for the current context) + --name string Override the name of the Connectors instance (the default name is the name specified in the connector configuration file) + --namespace string ID of the namespace for the Connectors instance (the default is the namespace for the current context) -o, --output string Specify the output format. Choose from: "json", "yaml", "yml" ``` @@ -38,5 +44,5 @@ rhoas connector create --file=myconnector.json ### SEE ALSO -* [rhoas connector](rhoas_connector.md) - Connectors instance commands +* [rhoas connector](rhoas_connector.md) - Connectors commands diff --git a/docs/commands/rhoas_connector_delete.md b/docs/commands/rhoas_connector_delete.md index 68a535e493..5678cf2b0e 100644 --- a/docs/commands/rhoas_connector_delete.md +++ b/docs/commands/rhoas_connector_delete.md @@ -4,7 +4,7 @@ Delete a Connectors instance ### Synopsis -Delete a Connectors instance by specifing its ID. Use the "connector list" command to see a list of all Connectors instances and their ID values. +Delete a Connectors instance by specifying its ID. Use the "connector list" command to see a list of all Connectors instances and their ID values. ``` rhoas connector delete [flags] @@ -13,8 +13,8 @@ rhoas connector delete [flags] ### Examples ``` -# Delete a Connectors instance with ID c9b71ucotd37bufoamkg -rhoas connector delete --id=c9b71ucotd37bufoamkg +# Delete a Connectors instance with ID myconnector +rhoas connector delete --id=myconnector ``` @@ -36,5 +36,5 @@ rhoas connector delete --id=c9b71ucotd37bufoamkg ### SEE ALSO -* [rhoas connector](rhoas_connector.md) - Connectors instance commands +* [rhoas connector](rhoas_connector.md) - Connectors commands diff --git a/docs/commands/rhoas_connector_describe.md b/docs/commands/rhoas_connector_describe.md index 1a6dbb1577..fb505e7a41 100644 --- a/docs/commands/rhoas_connector_describe.md +++ b/docs/commands/rhoas_connector_describe.md @@ -13,7 +13,7 @@ rhoas connector describe [flags] ### Examples ``` -# Get the Connectors instance details +#Get the Connectors instance details rhoas connector describe --id=c980124otd37bufiemj0 ``` @@ -34,5 +34,5 @@ rhoas connector describe --id=c980124otd37bufiemj0 ### SEE ALSO -* [rhoas connector](rhoas_connector.md) - Connectors instance commands +* [rhoas connector](rhoas_connector.md) - Connectors commands diff --git a/docs/commands/rhoas_connector_list.md b/docs/commands/rhoas_connector_list.md index 1540a8df56..56e3e3b32d 100644 --- a/docs/commands/rhoas_connector_list.md +++ b/docs/commands/rhoas_connector_list.md @@ -36,5 +36,5 @@ rhoas connector list ### SEE ALSO -* [rhoas connector](rhoas_connector.md) - Connectors instance commands +* [rhoas connector](rhoas_connector.md) - Connectors commands diff --git a/docs/commands/rhoas_connector_namespace.md b/docs/commands/rhoas_connector_namespace.md index 1250c71d78..1a01529da0 100644 --- a/docs/commands/rhoas_connector_namespace.md +++ b/docs/commands/rhoas_connector_namespace.md @@ -31,7 +31,7 @@ $ rhoas connector namespace list ### SEE ALSO -* [rhoas connector](rhoas_connector.md) - Connectors instance commands +* [rhoas connector](rhoas_connector.md) - Connectors commands * [rhoas connector namespace create](rhoas_connector_namespace_create.md) - Create a Connectors namespace * [rhoas connector namespace list](rhoas_connector_namespace_list.md) - Get a list of Connectors namespaces * [rhoas connector namespace use](rhoas_connector_namespace_use.md) - Set the current namespace in context diff --git a/docs/commands/rhoas_connector_namespace_list.md b/docs/commands/rhoas_connector_namespace_list.md index e0497188bc..1619f3bcda 100644 --- a/docs/commands/rhoas_connector_namespace_list.md +++ b/docs/commands/rhoas_connector_namespace_list.md @@ -4,7 +4,7 @@ Get a list of Connectors namespaces ### Synopsis -Get a list of Connectors namespaces for the Connectors cluster. The "connector namespace list" returns details about the namespaces, including their ID values. +Get a list of Connectors namespaces for the Connectors cluster. The "connector namespace list" command returns details about the namespaces including their ID values. ``` diff --git a/docs/commands/rhoas_connector_start.md b/docs/commands/rhoas_connector_start.md index 709355b7f1..49402b0f5a 100644 --- a/docs/commands/rhoas_connector_start.md +++ b/docs/commands/rhoas_connector_start.md @@ -37,5 +37,5 @@ rhoas connector start --id=IJD76DUH675234 ### SEE ALSO -* [rhoas connector](rhoas_connector.md) - Connectors instance commands +* [rhoas connector](rhoas_connector.md) - Connectors commands diff --git a/docs/commands/rhoas_connector_stop.md b/docs/commands/rhoas_connector_stop.md index 31013d1728..d5ed5185a5 100644 --- a/docs/commands/rhoas_connector_stop.md +++ b/docs/commands/rhoas_connector_stop.md @@ -4,7 +4,7 @@ Stop a Connectors instance ### Synopsis -Stop the current Connectors instance or stop a Connectors instance by providing its ID +Stop the current Connectors instance or stop a Connectors instance by providing its ID. ``` rhoas connector stop [flags] @@ -13,11 +13,11 @@ rhoas connector stop [flags] ### Examples ``` -# Stop current Connectors instance +# Stop the current Connectors instance rhoas connector stop # Stop a Connectors instance by specifying its ID -rhoas connector stop --id=IJD76DUH675234 +rhoas connector stop --id= ``` @@ -37,5 +37,5 @@ rhoas connector stop --id=IJD76DUH675234 ### SEE ALSO -* [rhoas connector](rhoas_connector.md) - Connectors instance commands +* [rhoas connector](rhoas_connector.md) - Connectors commands diff --git a/docs/commands/rhoas_connector_type.md b/docs/commands/rhoas_connector_type.md index 5b7dd5770e..0d96e95fed 100644 --- a/docs/commands/rhoas_connector_type.md +++ b/docs/commands/rhoas_connector_type.md @@ -1,14 +1,15 @@ ## rhoas connector type -List and get details of different connector types +List and get details of the different connector types ### Synopsis -List, search and get details of connector types that are available to use in the connector catalog. +List and get details of connector types that are available in the connector catalog. -Use list to list available connector types. +To see a list of all available connector types, use the "type list" command. +You can optionally use the "--search" flag to filter the requested results by Connector types that start with or contain text that you specify. -Use describe to get more details about a specific connector type. +To see a description of a specific connector type, use the "type details" command. ### Examples @@ -17,11 +18,11 @@ Use describe to get more details about a specific connector type. # List all connector types rhoas connector type list -# List all connector types that start with 'Amazon' +# List all connector types that start with "Amazon" rhoas connector type list --search=Amazon% -# Get more details of connector type with a type id of IEJF87hg2342hsdHFG -rhoas connector type describe --id=IEJF87hg2342hsdHFG +# Get all of the details for the connector type by specifying the type ID +rhoas connector type describe --type=aws_kinesis_sink_0.1 ``` @@ -34,7 +35,7 @@ rhoas connector type describe --id=IEJF87hg2342hsdHFG ### SEE ALSO -* [rhoas connector](rhoas_connector.md) - Connectors instance commands +* [rhoas connector](rhoas_connector.md) - Connectors commands * [rhoas connector type describe](rhoas_connector_type_describe.md) - Get details of a connector type * [rhoas connector type list](rhoas_connector_type_list.md) - List connector types diff --git a/docs/commands/rhoas_connector_type_describe.md b/docs/commands/rhoas_connector_type_describe.md index 44141614d1..892587a019 100644 --- a/docs/commands/rhoas_connector_type_describe.md +++ b/docs/commands/rhoas_connector_type_describe.md @@ -13,10 +13,10 @@ rhoas connector type describe [flags] ### Examples ``` -# Desribe connector type with id of slack_source_0.1 +# Describe connector type with id of slack_source_0.1 rhoas connector type describe --type=slack_source_0.1 -# Desribe connector type with id of slack_source_0.1 and give output as yaml +# Describe connector type with id of slack_source_0.1 and give output as yaml rhoas connector type describe --type=slack_source_0.1 -o yaml ``` @@ -37,5 +37,5 @@ rhoas connector type describe --type=slack_source_0.1 -o yaml ### SEE ALSO -* [rhoas connector type](rhoas_connector_type.md) - List and get details of different connector types +* [rhoas connector type](rhoas_connector_type.md) - List and get details of the different connector types diff --git a/docs/commands/rhoas_connector_type_list.md b/docs/commands/rhoas_connector_type_list.md index 88daf073ca..6615fd1675 100644 --- a/docs/commands/rhoas_connector_type_list.md +++ b/docs/commands/rhoas_connector_type_list.md @@ -4,7 +4,10 @@ List connector types ### Synopsis -List connector types available from the catalog, use filter options such as --limit, --page and --search +List the types of connectors that you are available in the Connectors catalog.' + +Use filter options, such as --limit, --page, and --search + ``` rhoas connector type list [flags] @@ -19,13 +22,12 @@ rhoas connector type list # List connector types with a limit of 10 from the second page rhoas connector type list --limit=10 --page=2 -# List all connector types that start with 'Amazon' +# List all connector types that start with "Amazon" rhoas connector type list --search=Amazon% -# List all connector types that contain the word 'Amazon' +# List all connector types that contain the word "Amazon" rhoas connector type list --search=%Amazon% - ``` ### Options @@ -46,5 +48,5 @@ rhoas connector type list --search=%Amazon% ### SEE ALSO -* [rhoas connector type](rhoas_connector_type.md) - List and get details of different connector types +* [rhoas connector type](rhoas_connector_type.md) - List and get details of the different connector types diff --git a/docs/commands/rhoas_connector_update.md b/docs/commands/rhoas_connector_update.md index 873d6c74ca..780cd6da61 100644 --- a/docs/commands/rhoas_connector_update.md +++ b/docs/commands/rhoas_connector_update.md @@ -4,12 +4,9 @@ Update a Connectors instance ### Synopsis -Update a Connectors instance +Update a Connectors instance. -Allows you to change the details of a already existing connectors instance. -By changing its configuration in a text editor. To change which editor use -edit the EDITOR environment variable. Below are some comman editors you may -use. +You can change the details of an existing Connectors instance by changing its configuration in a text editor. To specify an editor, use the EDITOR environment variable before you run the "rhoas connector update" command. For example: export EDITOR=nvim export EDITOR=vim @@ -34,9 +31,9 @@ cat myconnector.json | rhoas connector update ### Options ``` - --kafka-id string ID of of the namespace you want the connector to be updated to - --name string Override name of the connector (by default name in the connector spec would be used) - --namespace-id string ID of of the kafka you want the connector to be updated to + --kafka-id string ID of the namespace in which you want to deploy the Connectors instance + --name string Override the name of the Connectors instance (the default name is the name specified in the connector configuration file) + --namespace-id string ID of of the Kafka instance that you want the Connectors instance to use -o, --output string Specify the output format. Choose from: "json", "yaml", "yml" ``` @@ -49,5 +46,5 @@ cat myconnector.json | rhoas connector update ### SEE ALSO -* [rhoas connector](rhoas_connector.md) - Connectors instance commands +* [rhoas connector](rhoas_connector.md) - Connectors commands diff --git a/docs/commands/rhoas_connector_use.md b/docs/commands/rhoas_connector_use.md index 729b3e2017..ad98a7772b 100644 --- a/docs/commands/rhoas_connector_use.md +++ b/docs/commands/rhoas_connector_use.md @@ -41,5 +41,5 @@ $ rhoas connector use --id=1iSY6RQ3JKI8Q0OTmjQFd3ocFRg ### SEE ALSO -* [rhoas connector](rhoas_connector.md) - Connectors instance commands +* [rhoas connector](rhoas_connector.md) - Connectors commands diff --git a/pkg/core/localize/locales/en/cmd/connectors.toml b/pkg/core/localize/locales/en/cmd/connectors.toml index 6132287d1a..1a4336027f 100644 --- a/pkg/core/localize/locales/en/cmd/connectors.toml +++ b/pkg/core/localize/locales/en/cmd/connectors.toml @@ -14,7 +14,9 @@ rhoas connector cluster addon-parameters one = 'Create, delete, and list Connectors clusters' [connector.cluster.cmd.longDescription] -one = 'A Connectors cluster is an OpenShift Dedicated instance for deploying your Connectors instances. Use the "connector cluster" command to create, delete, and view a list of Connectors clusters.' +one = ''' +A Connectors cluster is an OpenShift Dedicated instance for deploying your Connectors instances. Use the "connector cluster" command to create, delete, and view a list of Connectors clusters. +''' [connector.cluster.cmd.example] one = ''' @@ -32,7 +34,10 @@ rhoas connector cluster list one = 'Create a Connectors cluster' [connector.cluster.create.cmd.longDescription] -one = 'Create a Connectors cluster and specify its name. You must be an org adminastrator for this to be successful' +one = 'Create a Connectors cluster and specify its name. You must have administrator access to run this command.' + +[connector.cluster.create.flag.name.description] +one = 'Name of the Connectors cluster to create' [connector.cluster.create.cmd.example] one = ''' @@ -48,7 +53,6 @@ Client ID: {{.ClientId}} Secret: {{.ClientSecret}} ''' - [connector.cluster.create.info.success] one = 'Successfully created the Connectors cluster named "{{.NAME}}" ' @@ -57,7 +61,7 @@ one = 'Delete a Connectors cluster' [connector.cluster.delete.cmd.longDescription] one = ''' -Delete a Connectors cluster by specifying its cluster ID. Use the "connector cluster list" command to see a list of all Connectors clusters and their ID values.' +Delete a Connectors cluster by specifying its cluster ID. To see a list of all Connectors clusters and their ID values, use the "connector cluster list" command. ''' [connector.cluster.delete.cmd.example] @@ -69,9 +73,6 @@ rhoas connector cluster delete --id=c980124otd37bufiemj0 [connector.cluster.delete.id.flag.description] one = 'ID of the Connectors cluster to delete' -[connector.cluster.create.flag.name.description] -one = 'Name of the Connectors cluster to create' - [connector.cluster.delete.info.success] one = 'Successfully deleted the Connectors cluster' @@ -103,56 +104,136 @@ one = 'Page limit' one = 'No results returned from the current command' [connector.common.validation.namespace.error.invalidChars] -one = 'invalid name for namespace "{{.Name}}"' +one = 'Invalid name for namespace "{{.Name}}"' [connector.cmd.shortDescription] -one = 'Connectors instance commands' +one = 'Connectors commands' [connector.cmd.longDescription] one = ''' -With Red Hat OpenShift Connectors, you can create and configure connections between Red Hat OpenShift Streams for Apache Kafka and third-party systems. You can configure Connectors that produce data (data source Connectors) and Connectors that specify where to send data (data sink Connectors). - -A Connectors instance is an instance of a one of the supported Connectors. -Use the "connector" command to create, delete, and view a list of Connectors instances. +With Red Hat OpenShift Connectors, you can create and configure connections between Red Hat OpenShift Streams for Apache Kafka and third-party systems. You can configure Connectors that retrieve data (data source Connectors) and Connectors that specify where to send data (data sink Connectors). ''' [connector.cmd.example] one = ''' -# List of Connectors instances -rhoas connector list +# List all connector types +rhoas connector type list -# Create a Connectors instance -rhoas connector create --file=myconnector.json +# Build a Connectors configuration file named "my_aws_lambda_connector.json" that is based on the "aws_lambda_sink_0.1" connector type +rhoas connector build --name=my_aws_lambda_connector --type=--type=aws_lambda_sink_0.1 -# Create a Connectors instance from stdin -cat myconnector.json | rhoas connector create +# Create a Connectors instance by specifying a configuration file +rhoas connector create --file=myconnector.json -# Update a Connectors instance +# Update an existing Connectors instance by specifying a configuration file rhoas connector update --id=my-connector --file=myconnector.json -# Update a Connectors instance from stdin -cat myconnector.json | rhoas connector update - -# Delete a Connectors instance with ID c9b71ucotd37bufoamkg -rhoas connector delete --id=c9b71ucotd37bufoamkg +# List of Connectors instances +rhoas connector list -# Start the Connectors instance with ID c9b71ucotd37bufoamkg -rhoas connector start --id=c9b71ucotd37bufoamkg +# Start the Connectors instance with ID my-connector +rhoas connector start --id=my-connector # Stop the current Connectors instance rhoas connector stop + +# Delete a Connectors instance with ID my-connector +rhoas connector delete --id=my-connector ''' -[connector.create.cmd.shortDescription] -one = 'Create a Connectors instance' +[connector.type.cmd.shortDescription] +description = "Short description of connector type command" +one = 'List and get details of the different connector types' -[connector.create.cmd.longDescription] -one = 'Create a Connectors instance' +[connector.type.cmd.longDescription] +description = "Long description of connector type command" +one = ''' +List and get details of connector types that are available in the connector catalog. -[connector.create.cmd.example] +To see a list of all available connector types, use the "type list" command. +You can optionally use the "--search" flag to filter the requested results by Connector types that start with or contain text that you specify. + +To see a description of a specific connector type, use the "type details" command. +''' + +[connector.type.cmd.example] +description = "Example commands for connector type" one = ''' -# Create a Connectors instance -rhoas connector create --file=myconnector.json +# List all connector types +rhoas connector type list + +# List all connector types that start with "Amazon" +rhoas connector type list --search=Amazon% + +# Get all of the details for the connector type by specifying the type ID +rhoas connector type describe --type=aws_kinesis_sink_0.1 +''' + +[connector.type.list.cmd.shortDescription] +description = "Short description of connector type list command" +one = 'List connector types' + +[connector.type.list.cmd.longDescription] +description = "Long description of connector type list command" +one = ''' +List the types of connectors that you are available in the Connectors catalog.' + +Use filter options, such as --limit, --page, and --search +''' + +[connector.type.list.cmd.example] +description = "Example commands for connector type list" +one = ''' +# List all connector types +rhoas connector type list + +# List connector types with a limit of 10 from the second page +rhoas connector type list --limit=10 --page=2 + +# List all connector types that start with "Amazon" +rhoas connector type list --search=Amazon% + +# List all connector types that contain the word "Amazon" +rhoas connector type list --search=%Amazon% +''' + +[connector.type.list.flag.page.description] +one = 'Page of the list based on limit' + +[connector.type.list.flag.search.description] +one = 'Search query for name of connector type' + +[connector.type.list.flag.limit.description] +one = 'The max number of connectors to return in the page' + +[connector.type.describe.info.success] +one = 'The Connectors type details were returned successfully' + +[connector.type.error.notFound] +one = 'The connector type with id "{{.Id}}" does not exist' + +[connector.type.error.noType] +one = 'No type id was passed to command' + +[connector.type.create.error.other] +one = 'error returned by api when creating connector instance: {{.Error}}' + +[connector.type.describe.flag.id] +one = 'The type id of the connector you want to get details about' + +[connector.type.describe.cmd.shortDescription] +one = 'Get details of a connector type' + +[connector.type.describe.cmd.longDescription] +one = 'Get full list of details of a connector type using its type id' + +[connector.type.describe.cmd.example] +one = ''' +# Describe connector type with id of slack_source_0.1 +rhoas connector type describe --type=slack_source_0.1 + +# Describe connector type with id of slack_source_0.1 and give output as yaml +rhoas connector type describe --type=slack_source_0.1 -o yaml ''' [connector.build.cmd.shortDescription] @@ -160,34 +241,38 @@ one = 'Build a Connectors instance' [connector.build.cmd.longDescription] one = ''' -Command builds specficication for Connector -instance that can be later created using create command. +Build a configuration file by specifying a connector type. +For a list of available connector types, use the "connector type list" command. + +After you build a configuration file, you can create a Connectors instance by using the "connector create" command and providing the name of the configuration file that you built. ''' [connector.build.cmd.example] one = ''' -# Build a Connectors instance +# Build a Connectors configuration file based on the "aws_lambda_sink_0.1" connector type. The default configuration file name is "connector.json" rhoas connector build --type=--type=aws_lambda_sink_0.1 -# Build a Connectors instance with a name of my_connector -rhoas connector build --name=my_connector --type=--type=aws_lambda_sink_0.1 - -cat myconnector.json | rhoas connector create +# Build a Connectors configuration file named "my_aws_lambda_connector.json" that is based on the "aws_lambda_sink_0.1" connector type +rhoas connector build --name=my_aws_lambda_connector --type=--type=aws_lambda_sink_0.1 ''' -[connector.stop.cmd.shortDescription] -one = 'Stop a Connectors instance' - -[connector.stop.cmd.longDescription] -one = 'Stop the current Connectors instance or stop a Connectors instance by providing its ID' +[connector.create.cmd.shortDescription] +one = 'Create a Connectors instance' -[connector.stop.cmd.example] +[connector.create.cmd.longDescription] one = ''' -# Stop current Connectors instance -rhoas connector stop +Create a Connectors instance. -# Stop a Connectors instance by specifying its ID -rhoas connector stop --id=IJD76DUH675234 +A Connectors instance is an instance of a one of the supported Connectors. +Use the "connector" command to create, delete, and view a list of Connectors instances. + +Before you create a Connectors instance, you must use the "connector build" command to create a configuration file for the type of connector that you want to create. +''' + +[connector.create.cmd.example] +one = ''' +# Create a Connectors instance by specifying a configuration file +rhoas connector create --file=myconnector.json ''' [connector.start.cmd.shortDescription] @@ -205,6 +290,21 @@ rhoas connector start rhoas connector start --id=IJD76DUH675234 ''' +[connector.stop.cmd.shortDescription] +one = 'Stop a Connectors instance' + +[connector.stop.cmd.longDescription] +one = 'Stop the current Connectors instance or stop a Connectors instance by providing its ID.' + +[connector.stop.cmd.example] +one = ''' +# Stop the current Connectors instance +rhoas connector stop + +# Stop a Connectors instance by specifying its ID +rhoas connector stop --id= +''' + [connector.create.info.success] one = 'Successfully created the Connectors instance' @@ -222,12 +322,9 @@ one = 'Update a Connectors instance' [connector.update.cmd.longDescription] one = ''' -Update a Connectors instance +Update a Connectors instance. -Allows you to change the details of a already existing connectors instance. -By changing its configuration in a text editor. To change which editor use -edit the EDITOR environment variable. Below are some comman editors you may -use. +You can change the details of an existing Connectors instance by changing its configuration in a text editor. To specify an editor, use the EDITOR environment variable before you run the "rhoas connector update" command. For example: export EDITOR=nvim export EDITOR=vim @@ -250,57 +347,57 @@ one = 'Successfully updated the Connectors instance' one = 'Location of the Connectors JSON file that describes the connector' [connector.flag.kafka.description] -one = 'Id of the kafka instance (by default kafka instance from context would be used)' +one = 'ID of the Kafka instance (the default is the Kafka instance for the current context)' [connector.flag.namespaceID.description] -one = 'ID of of the namespace you want the connector to be updated to' +one = 'ID of the namespace in which you want to deploy the Connectors instance' [connector.flag.kafkaID.description] -one = 'ID of of the kafka you want the connector to be updated to' +one = 'ID of of the Kafka instance that you want the Connectors instance to use' [connector.flag.namespace.description] -one = 'Id of the namespace for the connector (by default namespace from context would be used)' +one = 'ID of the namespace for the Connectors instance (the default is the namespace for the current context)' [connector.flag.name.description] -one = 'Override name of the connector (by default name in the connector spec would be used)' +one = 'Override the name of the Connectors instance (the default name is the name specified in the connector configuration file)' [connector.flag.sa.description] -one = 'If set, the connector will be created with the newly specified service account' +one = 'If set, the connector is created with the specified service account' [connector.build.file.flag.description] -one = 'filename of the connector specification file' +one = 'The filename of the connector configuration file' [connector.build.name.flag.description] -one = 'name of the connector' +one = 'The name of the connector type that was used to build a configuration file' [connector.build.overwrite.flag.description] -one = 'should overwrite file if exist' +one = 'Overwrite the file if it aready exists' [connector.build.info.msg] -one = 'Creating connector specification' +one = 'Creating a Connector configuraton file' [connector.build.type.flag.description] -one = 'Connector type (id of the connector)' +one = 'The type of the connector in the catalog (the same as the ID value for the connector in the catalog)' [connector.build.info.success] one = ''' -Connector specification successfully created. -You can edit the specification in your editor and use the "rhoas connector create --file={{.PATH}}" command to create the connectors instance. +Connector configuration file successfully created. + +You can edit the configuration in your text editor. -Information like connector namespace and service accounts can be supplied at the time of the creation. -You can generate new service account using rhoas service-account create command. +To create a Connectors instance, use the "rhoas connector create --file={{.PATH}}" command. ''' [connector.delete.cmd.shortDescription] one = 'Delete a Connectors instance' [connector.delete.cmd.longDescription] -one = 'Delete a Connectors instance by specifing its ID. Use the "connector list" command to see a list of all Connectors instances and their ID values.' +one = 'Delete a Connectors instance by specifying its ID. Use the "connector list" command to see a list of all Connectors instances and their ID values.' [connector.delete.cmd.example] one = ''' -# Delete a Connectors instance with ID c9b71ucotd37bufoamkg -rhoas connector delete --id=c9b71ucotd37bufoamkg +# Delete a Connectors instance with ID myconnector +rhoas connector delete --id=myconnector ''' [connector.delete.flag.id.description] @@ -320,7 +417,7 @@ one = 'Get the details for the Connectors instance by specifying its ID. Use the [connector.describe.cmd.example] one = ''' -# Get the Connectors instance details +#Get the Connectors instance details rhoas connector describe --id=c980124otd37bufiemj0 ''' @@ -378,7 +475,7 @@ one = 'Get a list of Connectors namespaces' [connector.namespace.list.cmd.longDescription] one = ''' -Get a list of Connectors namespaces for the Connectors cluster. The "connector namespace list" returns details about the namespaces, including their ID values. +Get a list of Connectors namespaces for the Connectors cluster. The "connector namespace list" command returns details about the namespaces including their ID values. ''' [connector.namespace.list.cmd.example] @@ -409,7 +506,7 @@ one = 'Successfully created the "{{.Name}}" namespace' one = 'Delete a Connectors namespace' [connector.namespace.delete.cmd.longDescription] -one = 'Delete a Connectors namespace by specifing its ID. Use the "connector namespace list" command to see a list of all Connectors namespaces and their ID values.' +one = 'Delete a Connectors namespace by specifying its ID. Use the "connector namespace list" command to see a list of all Connectors namespaces and their ID values.' [connector.namespace.delete.cmd.example] one = ''' @@ -484,66 +581,6 @@ one = "Connector instance with ID {{.ID}} not found" description = "Error message for when a Connectors instance name is not found" one = "Connector instance with name {{.Name}} not found" -[connector.type.cmd.shortDescription] -description = "Short description of connector type command" -one = 'List and get details of different connector types' - -[connector.type.cmd.longDescription] -description = "Long description of connector type command" -one = '''List, search and get details of connector types that are available to use in the connector catalog. - -Use list to list available connector types. - -Use describe to get more details about a specific connector type. -''' - -[connector.type.cmd.example] -description = "Example commands for connector type" -one = ''' -# List all connector types -rhoas connector type list - -# List all connector types that start with 'Amazon' -rhoas connector type list --search=Amazon% - -# Get more details of connector type with a type id of IEJF87hg2342hsdHFG -rhoas connector type describe --id=IEJF87hg2342hsdHFG -''' - -[connector.type.list.cmd.shortDescription] -description = "Short description of connector type list command" -one = 'List connector types' - -[connector.type.list.cmd.longDescription] -description = "Long description of connector type list command" -one = 'List connector types available from the catalog, use filter options such as --limit, --page and --search' - -[connector.type.list.cmd.example] -description = "Example commands for connector type list" -one = ''' -# List all connector types -rhoas connector type list - -# List connector types with a limit of 10 from the second page -rhoas connector type list --limit=10 --page=2 - -# List all connector types that start with 'Amazon' -rhoas connector type list --search=Amazon% - -# List all connector types that contain the word 'Amazon' -rhoas connector type list --search=%Amazon% - -''' - -[connector.type.list.flag.page.description] -one = 'Page of the list based on limit' - -[connector.type.list.flag.search.description] -one = 'Search query for name of connector type' - -[connector.type.list.flag.limit.description] -one = 'The max number of connectors to return in the page' - [connector.common.error.unauthorized] one = 'Auth token provided is invalid' @@ -553,63 +590,32 @@ one = 'Failed to parse search query' [connector.common.error.internalServerError] one = 'Unexpected internal server error occured' -[connector.type.describe.info.success] -one = 'The Connectors type details were returned successfully' - -[connector.type.error.notFound] -one = 'The connector type with id "{{.Id}}" does not exist' - -[connector.type.error.noType] -one = 'No type id was passed to command' - -[connector.type.create.error.other] -one = 'error returned by api when creating connector instance: {{.Error}}' - -[connector.type.describe.flag.id] -one = 'The type id of the connector you want to get details about' - -[connector.type.describe.cmd.shortDescription] -one = 'Get details of a connector type' - -[connector.type.describe.cmd.longDescription] -one = 'Get full list of details of a connector type using its type id' - -[connector.type.describe.cmd.example] -one = ''' -# Desribe connector type with id of slack_source_0.1 -rhoas connector type describe --type=slack_source_0.1 - -# Desribe connector type with id of slack_source_0.1 and give output as yaml -rhoas connector type describe --type=slack_source_0.1 -o yaml -''' - [connector.message.reading.file.error] one = 'supplied file is invalid. please make sure that file exist and it contains connector specification' - [connector.common.error.FileAlreadyExists] -one = 'provided {{.Name}} file already exist. Please specify --overwrite flag to overwrite the file' +one = 'provided {{.Name}} file already exists. Specify the --overwrite flag if you want to overwrite the existing file' [connector.interactive.error] -one = 'Connector specification missing required value: {{.Field}}' +one = 'Connector specification missing a required value: {{.Field}}' [connector.type.update.error.other] -one = 'Error while updating connector {{.Error}}' +one = 'Error while updating Connectors instance {{.Error}}' [connector.update.error.authTokenInvalid] one = 'The auth token used is invalid when updating connector' [connector.update.error.noMatchingResource] -one = 'There was no matching resource to the one requested when updating connector' +one = 'There was no matching resource to the one requested when updating the Connectors instance' [connector.update.error.doesNotExistAnymore] one = 'The requested resource does not exist anymore' [connector.update.error.unexpectedError] -one = 'Unexpected error occured when updating connector' +one = 'Unexpected error occured when updating the Connectors instance' [connector.update.info.editor.open] -one = 'Opening a text editor to edit connector details, close the editor to continue' +one = 'Opening a text editor to edit the Connectors instance details, close the editor to continue' [connector.common.page.prompt] one = 'Page'