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.

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

Updated Repos #15

Merged
merged 23 commits into from
Oct 20, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
ac4ad75
New article for using dsbulk with cassandra
fmanimali Sep 30, 2022
ebac57b
Adding new article about dsbulk
fmanimali Oct 4, 2022
62b5f4c
Added ® to cassandra
fmanimali Oct 4, 2022
b83e543
Corrected few typos and added bullet points at the end of each command
fmanimali Oct 4, 2022
54c86cb
missing space
fmanimali Oct 4, 2022
b7b9409
typO
fmanimali Oct 4, 2022
ec0d3cf
added backtick to cassandra name
fmanimali Oct 4, 2022
69a1638
trying to make the code block more readable
fmanimali Oct 4, 2022
96bb40e
indentation
fmanimali Oct 4, 2022
64d9b27
Formatting and spelling/dictionary fixes
Oct 12, 2022
b414bc9
fixed commands
ftisiot Oct 18, 2022
f0e2ff3
Create support center article
Oct 14, 2022
f3b31be
Update docs/platform/howto/project-support-center.rst
staceysalamon-aiven Oct 14, 2022
17ab1d4
Change wording as requested
Oct 17, 2022
ce773a4
Create support center article
Oct 14, 2022
31a5036
Update docs/platform/howto/project-support-center.rst
staceysalamon-aiven Oct 14, 2022
31d7d5f
Update docs/platform/howto/project-support-center.rst
staceysalamon-aiven Oct 17, 2022
3d87d1f
Update support center article
staceysalamon-aiven Oct 17, 2022
b248588
Update support center article
staceysalamon-aiven Oct 17, 2022
59a2d7e
Fix: update only relevant files
staceysalamon-aiven Oct 20, 2022
32ce156
Fixed a couple links and email reference
ftisiot Oct 20, 2022
74eb91a
Merge pull request #1458 from aiven/staceys-support-center
ftisiot Oct 20, 2022
3c86bca
Merge pull request #1433 from aiven/use-dsbulk-load-cassandra
ftisiot Oct 20, 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
1 change: 1 addition & 0 deletions .github/vale/dicts/aiven.dic
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ Docker
dockerized
downsampled
downsampling
DSBulk
Elasticsearch
Epicurious
etcd
Expand Down
4 changes: 3 additions & 1 deletion _toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,8 @@ entries:
- file: docs/platform/howto/saml/setup-saml-okta
title: Setting up SAML with Okta
- file: docs/platform/howto/saml/setup-saml-auth0
title: Setting up SAML with Auth0
title: Setting up SAML with Auth0
- file: docs/platform/howto/project-support-center
- file: docs/platform/reference
title: Reference
entries:
Expand Down Expand Up @@ -756,6 +757,7 @@ entries:
- file: docs/products/cassandra/howto/connect-go
- file: docs/products/cassandra/howto/connect-cqlsh-cli
- file: docs/products/cassandra/howto/use-nosqlbench-with-cassandra
- file: docs/products/cassandra/howto/use-dsbulk-with-cassandra
- file: docs/products/cassandra/reference
title: Reference
entries:
Expand Down
35 changes: 35 additions & 0 deletions docs/platform/howto/project-support-center.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
Get support in the Aiven console
=================================

Aiven is committed to providing excellent and responsive support to all of our customers. We are constantly monitoring our services 24/7 and rapidly addressing any anomalies.

In addition to our standard support, we offer three additional tiers that include faster response times and phone support. For more information about support plans, please see `Aiven support details page <https://aiven.io/support-services>`_ or contact [email protected] to discuss premium support.


You can create and track support tickets in the Project Support Center in the `Aiven Console <https://console.aiven.io/>`_.

Create a support ticket
~~~~~~~~~~~~~~~~~~~~~~~~

To create support tickets in the `Aiven Console <https://console.aiven.io/>`_:

#. Click **Support** to open the Project Support Center.
#. Click **Open support ticket**.
#. Enter a title and detailed description of the issue that you're experiencing.
#. Select the affected service and a severity level.
#. Click **Create ticket**.

Your new ticket is sent to our support team for review and you also receive an confirmation email. You can reply to this email to update your ticket with new information. Replies from the Aiven support team will be sent directly to your email.

You can also track the status of your tickets and review them from the project support center.

Add followers to an open ticket
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

If other users want to track and manage a ticket, the owner can add them to an open ticket by the owner of the ticket:

#. Click **Support** to open the Project Support Center.
#. Find the ticket you want to add users to in the list and click **Add follower**.
#. Select the user's email and click **Add follower**.

You can also add users to a ticket by copying them into the support ticket email.
143 changes: 143 additions & 0 deletions docs/products/cassandra/howto/use-dsbulk-with-cassandra.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,143 @@
Use DSBULK to load, unload and count data on Aiven service for Cassandra®
#########################################################################

`DSBulk <https://docs.datastax.com/en/dsbulk/docs/reference/dsbulkCmd.html>`_ is a highly configurable tool used to load, unload and count data in Apache Cassandra®.
It has configurable consistency levels for loading and unloading and offers the most accurate way to count records in Cassandra.

Prerequisites
-------------

To install the latest release of DSBulk, download the ``.zip`` or ``.tar.gz`` file from the `DSBulk GitHub repository <https://github.com/datastax/dsbulk>`_.


.. Tip::

You can read more about the DSBulk different use cases and manual pages in the `dedicated documentation <https://docs.datastax.com/en/dsbulk/docs/getStartedDsbulk.html>`_

Variables
---------

These are the placeholders you will need to replace in the code sample:

================== =============================================================
Variable Description
================== =============================================================
``PASSWORD`` Password of the ``avnadmin`` user
``HOST`` Host name for the connection
``PORT`` Port number to use for the Cassandra service
``SSL_CERTFILE`` Path of the `CA Certificate` for the Cassandra service
================== =============================================================

.. Tip::

All the above variables and the CA Certificate file can be found in the `Aiven Console <https://console.aiven.io/>`_, in the service detail page.

Preparation of the environment
------------------------------

In order for ``dsbulk`` to read the security certificate to connect to Aiven service for Cassandra, the certificate must be imported in a truststore.

1. Download the certificate from the service overview page of your Aiven for Apache Cassandra service. Save the CA certificate
in a file called ``cassandra-certificate.pem`` in a directory on the linux system where ``dsbulk`` runs.

2. Run this command line to create a truststore file and import the certificate in it::

keytool -import -v \
-trustcacerts \
-alias CARoot \
-file cassandra-certificate.pem \
-keystore client.truststore

A truststore file called ``client.truststore`` is created in the directory where the ``keytool`` command has been launched.

The ``keytool`` command assumes the file ``cassandra-certificate.pem`` is in the same directory where you run ``keytool``. If that is not the case, provide a full path to ``cassandra-certificate.pem``.

During creation of the truststore, you need to set a password that is required to access the truststore and retrieve the certificate.

3. The next step is to create a configuration file with the connection information.

By creating a configuration file, the ``dsbulk`` command line is more readable and it doesn't show passwords in clear text. If you don't create a configuration file, every option must be explicitly provided on the command line.

4. Create a file that contains the connection configuration like the following::

datastax-java-driver {
advanced {
ssl-engine-factory {
keystore-password = "cassandra"
keystore-path = "/home/user1/client.truststore"
class = DefaultSslEngineFactory
truststore-password = "cassandra"
truststore-path = "/home/user1/client.truststore"
}
auth-provider {
username = avnadmin
password = AVNS_JHMJgrFwIa-uPd7BwEB
}
}
}

The DSBulk configuration file can contain many different blocks for different configurations. In the above example, it only the ``datastax-java-driver`` block is filled.
The ``ssl-engine-factory`` block contains the path of the truststore and the related password.

.. Tip::

The Cassandra documentation has both `full reference and templates of the application configuration file <https://github.com/datastax/dsbulk/blob/1.x/manual/application.template.conf>`_ and a `full reference of the driver configuration file <https://github.com/datastax/dsbulk/blob/1.x/manual/driver.template.conf>`_.


Run a ``dsbulk`` command to count records in a Cassandra table
--------------------------------------------------------------

Once the configuration file is created, you can run the ``dsbulk``.

1. Navigate to the `bin` subdirectory of the downloaded ``dsbulk`` package

2. Run the following command::

./dsbulk count \
-f /full/path/to/conf.file \
-k baselines \
-t keyvalue \
-h HOST \
-port PORT \
--log.verbosity 2

where:

* ``baselines`` and ``keyvalue`` are the names of the example keyspace and table in the Cassandra database.
* ``log.verbosity`` controls the amount of logging that is sent at standard output when ``dsbulk`` runs. ``verbosity=2`` is used only to troubleshoot problems. To reduce verbosity, reduce the number to 1 or remove the option altogether.
* ``-f`` specifies the path to the configuration file
* ``-h`` and ``-p`` are the hostname and port number to connect to Cassandra.


Extract data from a Cassandra table in CSV format
------------------------------------------------------------

To extract the data from a table, you can use the following command::

./dsbulk unload \
-f ../conf.file \
-k baselines \
-t keyvalue \
-h HOST \
-port PORT

This command will extract all records from the table and output in a CSV format.

.. Tip::

In order to download the data in a file, the output can be redirected to a file.

Load data into a Cassandra table from a CSV file
------------------------------------------------

To load data into a Cassandra table, the command line is very similar to the previous command::

./dsbulk load \
-f ../conf.file \
-k baselines \
-t keyvalue \
-h HOST \
-port PORT \
-url data.csv

where the file ``data.csv`` is the file that contains the data to load into Cassandra.
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Prerequisites
To download the latest nosqlbench release, search for "latest" in `nosqlbench GitHub repository <https://github.com/nosqlbench/nosqlbench/releases/latest>`_.
Nosqlbench can be downloaded as a Linux binary executable called ``nb``. The ``nb`` executable is built with all java libraries and includes a number of sample scenarios ready to be run.


.. Tip::

You can read more about the nosqlbench core concepts and parameters in the `dedicated documentation <https://docs.nosqlbench.io/docs/nosqlbench/core-concepts/>`_
Expand Down