Skip to content

Commit d170730

Browse files
author
Marcelo Vanzin
committed
[SPARK-10676] [docs] Add documentation for SASL encryption options.
1 parent c88bb5d commit d170730

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

docs/security.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,8 @@ If your applications are using event logging, the directory where the event logs
2323

2424
## Encryption
2525

26-
Spark supports SSL for Akka and HTTP (for broadcast and file server) protocols. However SSL is not supported yet for WebUI and block transfer service.
26+
Spark supports SSL for Akka and HTTP (for broadcast and file server) protocols. SASL encryption is
27+
supported for the block transfer service. Encryption is not yet supported for the WebUI.
2728

2829
Connection encryption (SSL) configuration is organized hierarchically. The user can configure the default SSL settings which will be used for all the supported communication protocols unless they are overwritten by protocol-specific settings. This way the user can easily provide the common settings for all the protocols without disabling the ability to configure each one individually. The common SSL settings are at `spark.ssl` namespace in Spark configuration, while Akka SSL configuration is at `spark.ssl.akka` and HTTP for broadcast and file server SSL configuration is at `spark.ssl.fs`. The full breakdown can be found on the [configuration page](configuration.html).
2930

@@ -47,6 +48,17 @@ follows:
4748
* Import all exported public keys into a single trust-store
4849
* Distribute the trust-store over the nodes
4950

51+
### Configuring SASL Encryption
52+
53+
To enable SASL encryption for an application, set `spark.authenticate.enableSaslEncryption` to
54+
`true`. Authentication (`spark.authenticate`) must also be turned on for this option to take
55+
effect.
56+
57+
When using an external shuffle service, it's possible to disable unencrypted connections by setting
58+
`spark.network.sasl.serverAlwaysEncrypt` to `true` in the shuffle service's configuration. If that
59+
option is enabled, applications that are not set up to use SASL encryption will fail to connect to
60+
the shuffle service.
61+
5062
## Configuring Ports for Network Security
5163

5264
Spark makes heavy use of the network, and some environments have strict requirements for using tight

0 commit comments

Comments
 (0)