Skip to content

Commit 01c1a58

Browse files
committed
minor fixes in documentation
1 parent cfb1b4e commit 01c1a58

File tree

3 files changed

+12
-12
lines changed

3 files changed

+12
-12
lines changed

README.adoc

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,14 @@
1-
# Cassandra Java Driver Kerberos Authenticator
1+
== Cassandra Java Driver Kerberos Authenticator
22

33
image:https://img.shields.io/maven-central/v/com.instaclustr/cassandra-driver-kerberos.svg?label=Maven%20Central[link=https://search.maven.org/search?q=g:%22com.instaclustr%22%20AND%20a:%22cassandra-driver-kerberos%22"]
4-
54
image:https://circleci.com/gh/instaclustr/cassandra-java-driver-kerberos.svg?style=svg["Instaclustr",link="https://circleci.com/gh/instaclustr/cassandra-java-driver-kerberos"]
65

7-
A GSSAPI authentication provider for the [Cassandra Java driver](https://github.com/datastax/java-driver).
6+
A GSSAPI authentication provider for the https://github.com/datastax/java-driver[Cassandra Java driver].
87

98
This driver plugin is intended to work with the
109
https://github.com/instaclustr/cassandra-kerberos[Cassandra kerberos authenticator] plugin for https://cassandra.apache.org/[Apache Cassandra].
1110

12-
## Usage
11+
=== Usage
1312

1413
The authenticator is distributed via Maven Central. To use, add the following dependency to your POM:
1514

@@ -21,16 +20,16 @@ The authenticator is distributed via Maven Central. To use, add the following de
2120
</dependency>
2221
----
2322

24-
### Pre-requisite setup steps
23+
=== Pre-requisite setup steps
2524

2625
- A Kerberos 5 KDC server is available
2726
- An NTP client is installed & configured on the application host, each Cassandra node, and the KDC. Ideally the application host syncs
2827
with the same time source as the KDC & Cassandra nodes in order to minimise potential time-sync issues.
29-
- If using Oracle Java, ensure that the [Java Cryptographic Extensions Unlimited Strength Jurisdiction Policy Files](https://www.oracle.com/technetwork/java/javase/downloads/jce8-download-2133166.html)
28+
- If using Oracle Java, ensure that the https://www.oracle.com/technetwork/java/javase/downloads/jce8-download-2133166.html[Java Cryptographic Extensions Unlimited Strength Jurisdiction Policy Files]
3029
are installed (not necessary when using OpenJDK or other JRE implementations)
31-
- Follow the instructions [here](https://github.com/instaclustr/cassandra-kerberos) to configure a Cassandra cluster for Kerberos authentication.
30+
- Follow the instructions https://github.com/instaclustr/cassandra-kerberos[here] to configure a Cassandra cluster for Kerberos authentication.
3231

33-
Configure the `/etc/krb5.conf` Kerberos config file (see [here](http://web.mit.edu/kerberos/www/krb5-latest/doc/admin/conf_files/krb5_conf.html) for further details).
32+
Configure the `/etc/krb5.conf` Kerberos config file (see http://web.mit.edu/kerberos/www/krb5-latest/doc/admin/conf_files/krb5_conf.html[here] for further details).
3433

3534
An example `krb5.conf` for the `EXAMPLE.COM` realm:
3635

@@ -57,7 +56,7 @@ default = FILE:/var/log/krb5libs.log
5756
See http://web.mit.edu/kerberos/www/krb5-latest/doc/admin/conf_files/krb5_conf.html[here] for further details.
5857

5958

60-
### How to use the authenticator plugin
59+
=== How to use the authenticator plugin
6160

6261
**Note:** *Please read the javadoc for full details on how to configure & use the plugin.*
6362

@@ -98,8 +97,8 @@ The location of the JAAS config file must be provided via the `java.security.aut
9897

9998
For example: `java -Djava.security.auth.login.config=/path/to/jaas.conf -jar MyApplication.jar`
10099

101-
## Build
100+
=== Build
102101

103102
If you would like to build the JAR package from source, checkout this project and run `mvn clean package`.
104103

105-
Please see https://www.instaclustr.com/support/documentation/announcements/instaclustr-open-source-project-status/ for Instaclustr support status of this project.
104+
Please see https://www.instaclustr.com/support/documentation/announcements/instaclustr-open-source-project-status/[status] for Instaclustr support status of this project.

pom.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@
6262
<groupId>com.datastax.oss</groupId>
6363
<artifactId>java-driver-core</artifactId>
6464
<version>${java-driver.version}</version>
65+
<scope>provided</scope>
6566
</dependency>
6667
</dependencies>
6768

src/main/java/com/instaclustr/cassandra/driver/auth/KerberosAuthProvider.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242
* authorization-id = application will assume role "cassandra" when not specified
4343
* sasl-protocol = "cassandra" when not specified
4444
* sasl-properties = optional sasl properties map where keys and values are strings
45-
* server-name-resolver = f.q.c.n of implementation of com.instaclustr.cassandra.driver.auth.ServerNameResolver, otherwise
45+
* server-name-resolver = f.q.c.n of implementation of com.instaclustr.cassandra.driver.auth.ServerNameResolver, otherwise not used
4646
* }
4747
* }
4848
* }</pre>

0 commit comments

Comments
 (0)