Skip to content

Commit e6c3b11

Browse files
authored
DOC-5616 Support Portal links (#34)
* remove links to support article * remove confusing sentence
1 parent 674f2c6 commit e6c3b11

3 files changed

Lines changed: 34 additions & 9 deletions

File tree

antora.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ asciidoc:
1010
attributes:
1111
# General attributes
1212
company: 'DataStax'
13-
support-url: 'https://support.datastax.com'
1413
# Other product attributes
1514
cass-reg: 'Apache Cassandra(R)'
1615
cass: 'Apache Cassandra'

in-progress/managing.adoc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2783,7 +2783,6 @@ This can act as a convenient alternative to installing and configuring a xref:as
27832783
To use `cqlsh` commands, you must have a supported version of Python installed on your system.
27842784
The underlying `cqlsh` utility requires Python 2.7 (with TLS support) or Python 3.6--3.11.
27852785
Python versions 3.12 and later are not supported.
2786-
For more details, see this https://support.datastax.com/s/article/cqlsh-may-fail-with-A-Python-installation-with-SSL-is-required-to-connect-to-a-cloud-cluster-when-connecting-to-Astra[Support article]
27872786

27882787
Use the `astra db cqlsh` command to start `cqlsh` in interactive mode:
27892788

modules/quickstarts/pages/cqlsh.adoc

Lines changed: 34 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,18 +12,45 @@ The first time you run an `astra db cqlsh` command, the {product} downloads and
1212
All `astra db cqlsh` commands require a database name or ID.
1313
The first time you connect to a specific database, {product} downloads the database's {scb} into the {product} home directory.
1414

15+
[#prerequisites]
1516
== Prerequisites
1617

17-
To use `cqlsh` commands, you must have a supported version of Python installed on your system.
18+
The `cqlsh` commands require one of the following supported versions of Python with SSL/TLS:
1819

19-
The underlying `cqlsh` utility requires Python 2.7 with TLS support, or any version of Python from 3.6 through 3.11.
20-
Python versions 3.12 and later are not supported.
21-
For more details, see this https://support.datastax.com/s/article/cqlsh-may-fail-with-A-Python-installation-with-SSL-is-required-to-connect-to-a-cloud-cluster-when-connecting-to-Astra[support article]
20+
* Python 3.6 to 3.11
21+
* Python 2.7.12 or later
2222
23-
Any supported version of Python must be available in your system's `PATH` for the {product} to use it.
24-
It does not require that the supported version be your system's default version of Python.
23+
All other versions aren't supported.
2524

26-
If the {product} reports `ModuleNotFoundError` after running any of the `astra db cqlsh` commands, you might not have a supported version of Python available in your system's `PATH`.
25+
Any supported Python version must be installed on your system _and_ available in your system's `PATH` for the {product} to use it with the `cqlsh` commands.
26+
This version doesn't need to be your system's default Python version as long as it's available in the `PATH`.
27+
28+
=== Troubleshoot ModuleNotFoundError and Python installation errors
29+
30+
If the {product} reports `ModuleNotFoundError` after running any of the `astra db cqlsh` commands, make sure you have a <<prerequisites,supported Python version>> available in your system's `PATH`.
31+
32+
The error `A Python installation with SSL is required to connect to a cloud cluster` means that the detected Python version doesn't support TLS.
33+
This typically happens with Python versions earlier than 2.7.12, which don't support TLS.
34+
35+
.Verify TLS support
36+
[%collapsible]
37+
====
38+
To verify whether your current Python version supports TLS, run the following command:
39+
40+
[source,shell]
41+
----
42+
python -c 'from ssl import SSLContext, PROTOCOL_TLS, CERT_REQUIRED'
43+
----
44+
45+
If TLS isn't supported, the following error is returned:
46+
47+
[source,console]
48+
----
49+
Traceback (most recent call last):
50+
File "<string>", line 1, in <module>
51+
ImportError: cannot import name PROTOCOL_TLS
52+
----
53+
====
2754

2855
== Start an interactive cqlsh session
2956

0 commit comments

Comments
 (0)