Skip to content

Commit a223795

Browse files
Updated documentation for kerberos support
1 parent a72c81b commit a223795

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,11 +68,12 @@ Request Body example:
6868
'username': 'username',
6969
'password': 'password',
7070
'endpoint': 'url',
71+
'auth': 'Kerberos',
7172
'kernelname': 'pysparkkernel'
7273
}
7374
```
7475

75-
*Note that the kernelname parameter is optional and defaults to the one specified on the config file or pysparkkernel if not on the config file.*
76+
*Note that the auth can be either None, Basic_Access or Kerberos based on the authentication enabled in livy. The kernelname parameter is optional and defaults to the one specified on the config file or pysparkkernel if not on the config file.*
7677
Returns `200` if successful; `400` if body is not JSON string or key is not found; `500` if error is encountered changing clusters.
7778

7879
Reply Body example:
@@ -107,6 +108,9 @@ However, there are some important limitations to note:
107108
2. Since all code is run on a remote driver through Livy, all structured data must be serialized to JSON and parsed by the Sparkmagic library so that it can be manipulated and visualized on the client side.
108109
In practice this means that you must use Python for client-side data manipulation in `%%local` mode.
109110

111+
## Kerberos support
112+
Sparkmagic uses [requests-kerberos](https://github.com/requests/requests-kerberos) package for kerberos support. The sparkmagic expects kerberos ticket to be avaibale in the system. It picks up the kerbros ticket from cache file. User needs to run kinit to create the kerberos ticket. The sparkmagic doesn't support passing kerberos principal/token.
113+
110114
## Contributing
111115

112116
We welcome contributions from everyone.

0 commit comments

Comments
 (0)