From 5f2a5af8d60ffb75252e0eb225d6cc08161f4938 Mon Sep 17 00:00:00 2001 From: Joel Hamill <11722533+joel-hamill@users.noreply.github.com> Date: Wed, 26 Sep 2018 10:00:30 -0700 Subject: [PATCH] DOCS-652 - Fix SR terminology (#1946) --- docs/faq.rst | 18 +++++++++--------- docs/includes/ksql-includes.rst | 2 +- .../installation/server-config/avro-schema.rst | 6 +++--- .../server-config/config-reference.rst | 2 +- docs/installation/server-config/security.rst | 14 +++++++------- docs/operations.rst | 2 +- docs/tutorials/basics-local.rst | 2 +- docs/tutorials/generate-custom-test-data.rst | 2 +- 8 files changed, 24 insertions(+), 24 deletions(-) diff --git a/docs/faq.rst b/docs/faq.rst index 03c9c4c9ee5d..9a81e4de3954 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -145,15 +145,15 @@ How can I lock-down KSQL servers for production and prevent interactive client a You can configure your servers to run a set of predefined queries by using ``ksql.queries.file`` or the ``--queries-file`` command line flag. For more information, see :ref:`ksql-server-config`. -==================================================================== -How do I use Avro data and integrate with Confluent Schema Registry? -==================================================================== +==================================================== +How do I use Avro data and integrate with |sr-long|? +==================================================== -Configure the ``ksql.schema.registry.url`` property in the KSQL server configuration to point to Schema Registry +Configure the ``ksql.schema.registry.url`` property in the KSQL server configuration to point to |sr| (see :ref:`install_ksql-avro-schema`). .. important:: - - To use Avro data with KSQL you must have Schema Registry installed. This is included by default with |cp|. + - To use Avro data with KSQL you must have |sr| installed. This is included by default with |cp|. - Avro message values are supported. Avro keys are not yet supported. ========================= @@ -200,11 +200,11 @@ Will KSQL work with a Apache Kafka cluster secured using Kafka ACLs? Yes. For more information, see :ref:`config-security-ksql-acl`. -====================================================== -Will KSQL work with a HTTPS Confluent Schema Registry? -====================================================== +====================================== +Will KSQL work with a HTTPS |sr-long|? +====================================== -Yes. KSQL can be configured to communicate with the Confluent Schema Registry over HTTPS. For more information, see +Yes. KSQL can be configured to communicate with |sr-long| over HTTPS. For more information, see :ref:`config-security-ksql-sr`. ================================================ diff --git a/docs/includes/ksql-includes.rst b/docs/includes/ksql-includes.rst index 86dc024aee24..8d3ea9eeb32c 100644 --- a/docs/includes/ksql-includes.rst +++ b/docs/includes/ksql-includes.rst @@ -246,7 +246,7 @@ the latest offset. #. Create a new persistent query that counts the pageviews for each region and gender combination in a :ref:`tumbling window ` of 30 seconds when the count is greater than 1. Results from this query are written to the ``PAGEVIEWS_REGIONS`` Kafka topic in the Avro format. KSQL will register the Avro schema with the - configured schema registry when it writes the first message to the ``PAGEVIEWS_REGIONS`` topic. + configured |sr| when it writes the first message to the ``PAGEVIEWS_REGIONS`` topic. .. code:: bash diff --git a/docs/installation/server-config/avro-schema.rst b/docs/installation/server-config/avro-schema.rst index e23f0fe4c44c..264dac005ad9 100644 --- a/docs/installation/server-config/avro-schema.rst +++ b/docs/installation/server-config/avro-schema.rst @@ -1,11 +1,11 @@ .. _install_ksql-avro-schema: -Avro and Schema Registry -======================== +Avro and |sr| +============= KSQL can read and write messages in Avro format by integrating with :ref:`Confluent Schema Registry `. KSQL automatically retrieves (read) and registers (write) Avro schemas as needed and thus saves you from both having to -manually define columns and data types in KSQL and from manual interaction with the Schema Registry. +manually define columns and data types in KSQL and from manual interaction with |sr|. .. contents:: Contents :local: diff --git a/docs/installation/server-config/config-reference.rst b/docs/installation/server-config/config-reference.rst index 0224191d81a8..8d684ea4820c 100644 --- a/docs/installation/server-config/config-reference.rst +++ b/docs/installation/server-config/config-reference.rst @@ -119,7 +119,7 @@ properties file: ksql.schema.registry.url ------------------------ -The Schema Registry URL path to connect KSQL to. +The |sr| URL path to connect KSQL to. .. _ksql-service-id: diff --git a/docs/installation/server-config/security.rst b/docs/installation/server-config/security.rst index 1fe297e083cd..7087293e9d34 100644 --- a/docs/installation/server-config/security.rst +++ b/docs/installation/server-config/security.rst @@ -3,7 +3,7 @@ Configuring Security for KSQL ============================= -KSQL supports many of the security features of both Apache Kafka and the |sr|. +KSQL supports many of the security features of both Apache Kafka and |sr|. - KSQL supports Apache Kafka security features such as :ref:`SSL for encryption `, :ref:`SASL for authentication `, and :ref:`authorization with ACLs `. @@ -28,10 +28,10 @@ You can use KSQL with a Kafka cluster in |ccloud|. For more information, see :re .. _config-security-ksql-sr: -Configuring KSQL for Secured Confluent Schema Registry ------------------------------------------------------- +Configuring KSQL for Secured |sr-long| +-------------------------------------- -The following configuration connects KSQL with the Confluent Schema Registry over HTTPS. +The following configuration connects KSQL with |sr-long| over HTTPS. #. Specify the HTTPS endpoint in the ``ksql.schema.registry.url`` setting in the KSQL server configuration file: @@ -40,17 +40,17 @@ The following configuration connects KSQL with the Confluent Schema Registry ove ksql.schema.registry.url=https://: -#. Specify any SSL or SASL configuration the Schema Registry client requires using the ``KSQL_OPTS`` +#. Specify any SSL or SASL configuration that the |sr| client requires using the ``KSQL_OPTS`` environment variable. - For example, if the Schema Registry's SSL certificate is not signed by a CA that is recognized by + For example, if the SSL certificate of |sr| is not signed by a CA that is recognized by the JVM by default, then you can provide a suitable truststore when starting KSQL via the command line: .. code:: bash $ KSQL_OPTS="-Djavax.net.ssl.trustStore= -Djavax.net.ssl.trustStorePassword=" ksql-server-start /etc/ksql/ksql-server.properties -The exact settings will vary depending on what SASL mechanism the Confluent Schema Registry is using is using and how your SSL certificates +The exact settings will vary depending on what SASL mechanism |sr-long| is using is using and how your SSL certificates are signed. For more information, see :ref:`schemaregistry_security`. .. _config-security-kafka: diff --git a/docs/operations.rst b/docs/operations.rst index e4dcae0dd09d..31067762579e 100644 --- a/docs/operations.rst +++ b/docs/operations.rst @@ -203,7 +203,7 @@ associated Avro schemas, they aren't automatically matched with the renamed topics. In the KSQL CLI, the ``PRINT`` statement for a replicated topic works, which shows -that the Avro schema ID exists in the Schema Registry, and KSQL can deserialize +that the Avro schema ID exists in |sr|, and KSQL can deserialize the Avro message. But ``CREATE STREAM`` fails with a deserialization error: .. code:: bash diff --git a/docs/tutorials/basics-local.rst b/docs/tutorials/basics-local.rst index bc2533e94ece..ebcbdc5542a7 100644 --- a/docs/tutorials/basics-local.rst +++ b/docs/tutorials/basics-local.rst @@ -11,7 +11,7 @@ this Kafka cluster. KSQL is installed in the |cp| by default. **Prerequisites:** - :ref:`Confluent Platform ` is installed and running. This installation includes a Kafka broker, KSQL, |c3-short|, - |zk|, Schema Registry, REST Proxy, and Kafka Connect. + |zk|, |sr|, REST Proxy, and Kafka Connect. - If you installed |cp| via TAR or ZIP, navigate into the installation directory. The paths and commands used throughout this tutorial assume that your are in this installation directory. - Java: Minimum version 1.8. Install Oracle Java JRE or JDK >= 1.8 on your local machine diff --git a/docs/tutorials/generate-custom-test-data.rst b/docs/tutorials/generate-custom-test-data.rst index 0ed4d6c94518..a4dc6cfc7e03 100644 --- a/docs/tutorials/generate-custom-test-data.rst +++ b/docs/tutorials/generate-custom-test-data.rst @@ -14,7 +14,7 @@ provide. - :ref:`Confluent Platform ` is installed and running. This installation includes a Kafka broker, KSQL, |c3-short|, |zk|, - Schema Registry, REST Proxy, and Kafka Connect. + |sr|, REST Proxy, and Kafka Connect. - If you installed |cp| via TAR or ZIP, navigate to the installation directory. The paths and commands used throughout this tutorial assume that you're in this installation directory.