### _Why are the changes needed?_ as title. ### _How was this patch tested?_ - [ ] Add some test cases that check the changes thoroughly including negative and positive cases if possible - [ ] Add screenshots for manual tests if appropriate - [ ] [Run test](https://kyuubi.readthedocs.io/en/master/develop_tools/testing.html#running-tests) locally before make a pull request Closes #4521 from turboFei/rest_docs. Closes #3739 589237ca6 [fwang12] save 8e7d9bec6 [fwang12] final 35b67ba1e [fwang12] doc 40163311f [fwang12] save 5711d3d72 [fwang12] fix bab07902f [fwang12] fix ut d58c2753a [fwang12] save 989eaffd5 [fwang12] remove 2960602bc [fwang12] remove outdate docs Authored-by: fwang12 <fwang12@ebay.com> Signed-off-by: fwang12 <fwang12@ebay.com>
2.8 KiB
2.8 KiB
Kyuubi Migration Guide
Upgrading from Kyuubi 1.7.0 to 1.7.1
- Since Kyuubi 1.7.1,
protocolVersionis removed from the request parameters of the REST APIOpen(create) a session. All removed or unknown parameters will be silently ignored and affects nothing.
Upgrading from Kyuubi 1.6 to 1.7
- In Kyuubi 1.7,
kyuubi.ha.zookeeper.engine.auth.typedoes not fallback tokyuubi.ha.zookeeper.auth.type.
When Kyuubi engine does Kerberos authentication with Zookeeper, user needs to explicitly setkyuubi.ha.zookeeper.engine.auth.typetoKERBEROS. - Since Kyuubi 1.7, Kyuubi returns engine's information for
GetInforequest instead of server. To restore the previous behavior, setkyuubi.server.info.providertoSERVER. - Since Kyuubi 1.7, Kyuubi session type
SQLis refactored toINTERACTIVE, because Kyuubi supports not onlySQLsession, but alsoSCALAandPYTHONsessions. User need to useINTERACTIVEsessionType to look up the session event. - Since Kyuubi 1.7, the REST API of
Open(create) a sessionwill not contain parametersuserpasswordandIpAddr. User and password should be set inAuthorizationof http request if needed.
Upgrading from Kyuubi 1.6.0 to 1.6.1
- Since Kyuubi 1.6.1,
kyuubi.ha.zookeeper.engine.auth.typedoes not fallback tokyuubi.ha.zookeeper.auth.type.
When Kyuubi engine does Kerberos authentication with Zookeeper, user needs to explicitly setkyuubi.ha.zookeeper.engine.auth.typetoKERBEROS.
Upgrading from Kyuubi 1.5 to 1.6
- Kyuubi engine gets Zookeeper principal & keytab from
kyuubi.ha.zookeeper.auth.principal&kyuubi.ha.zookeeper.auth.keytab.
kyuubi.ha.zookeeper.auth.principal&kyuubi.ha.zookeeper.auth.keytabfallback tokyuubi.kinit.principal&kyuubi.kinit.keytabwhen not set.
Since Kyuubi 1.6,kyuubi.kinit.principal&kyuubi.kinit.keytabare filtered out from Kyuubi engine's conf for better security.
When Kyuubi engine does Kerberos authentication with Zookeeper, user needs to explicitly setkyuubi.ha.zookeeper.auth.principal&kyuubi.ha.zookeeper.auth.keytab.