kyuubi/docs/security/authentication.rst
liangbowen ab1c46d431 [KYUUBI #5154] [Doc] Move configuration docs to the top level
### _Why are the changes needed?_

- Move the configuration docs to the top level of docs, which is most commonly used and referenced
- update relevant doc links

![image](https://github.com/apache/kyuubi/assets/1935105/a1dd35cc-d37f-4294-9fed-b275956c2cc5)

### _How was this patch tested?_
- [x] Add some test cases that check the changes thoroughly including negative and positive cases if possible

- [ ] Add screenshots for manual tests if appropriate

- [x] [Run test](https://kyuubi.readthedocs.io/en/master/contributing/code/testing.html#running-tests) locally before make a pull request

Closes #5154 from bowenliang123/config-doc-first.

Closes #5154

b49ed3f8b [liangbowen] nit
db7f0d14d [liangbowen] update doc links
f8fd697a2 [liangbowen] move config docs to the top level
7448e4487 [liangbowen] change title of settings doc
40214ddd8 [liangbowen] move config doc in the front of deployment

Authored-by: liangbowen <liangbowen@gf.com.cn>
Signed-off-by: liangbowen <liangbowen@gf.com.cn>
2023-08-11 18:23:08 +08:00

47 lines
1.8 KiB
ReStructuredText

.. Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
.. http://www.apache.org/licenses/LICENSE-2.0
.. Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Kyuubi Authentication Mechanism
=================================
In a secure cluster, services should be able to identify and authenticate
callers. As the fact that the user claims does not necessarily mean this
is true.
The authentication process of kyuubi is used to verify the user identity
that a client used to talk to the kyuubi server. Once done, a trusted
connection will be set up between the client and server if successful;
otherwise, rejected.
.. note:: This only authenticate whether a user or client can connect
with Kyuubi server or not using the provided identity.
For other secured services that this user wants to interact with, he/she
also needs to pass the authentication process of each service, for instance,
Hive Metastore, YARN, HDFS.
The related configurations can be found at `Authentication Configurations`_
.. toctree::
:maxdepth: 2
kerberos
../client/advanced/kerberos
ldap
jdbc
../extensions/server/authentication
.. _Authentication Configurations: ../configuration/settings.html#authentication