Skip to content

Commit

Permalink
[apache#4467] docs: Refactor the security document and add access con…
Browse files Browse the repository at this point in the history
…trol page (apache#4496)

### What changes were proposed in this pull request?

Refactor the security document and add access control  page.

### Why are the changes needed?

Fix: apache#4467

### Does this PR introduce _any_ user-facing change?

No.

### How was this patch tested?
Just docs.
  • Loading branch information
jerqi committed Aug 15, 2024
1 parent 7854745 commit 8293bed
Show file tree
Hide file tree
Showing 16 changed files with 1,013 additions and 336 deletions.
Binary file added docs/assets/object.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/privilege.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/role.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/user-group.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/workflow.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/gravitino-server-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ For more details, please refer to the definition of the plugin.

### Security configuration

Refer to [security](security.md) for HTTPS and authentication configurations.
Refer to [security](security/security.md) for HTTPS and authentication configurations.

### Metrics configuration

Expand Down
4 changes: 2 additions & 2 deletions docs/how-to-use-gvfs.md
Original file line number Diff line number Diff line change
Expand Up @@ -274,7 +274,7 @@ FileSystem fs = filesetPath.getFileSystem(conf);
##### Using `OAuth` authentication

If you want to use `oauth2` authentication for the Gravitino client in the Gravitino Virtual File System,
please refer to this document to complete the configuration of the Gravitino server and the OAuth server: [Security](./security.md).
please refer to this document to complete the configuration of the Gravitino server and the OAuth server: [Security](security/security.md).

Then, you can configure the Hadoop configuration like this:

Expand All @@ -298,7 +298,7 @@ FileSystem fs = filesetPath.getFileSystem(conf);
##### Using `Kerberos` authentication

If you want to use `kerberos` authentication for the Gravitino client in the Gravitino Virtual File System,
please refer to this document to complete the configuration of the Gravitino server: [Security](./security.md).
please refer to this document to complete the configuration of the Gravitino server: [Security](security/security.md).

Then, you can configure the Hadoop configuration like this:

Expand Down
2 changes: 1 addition & 1 deletion docs/iceberg-rest-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ You can also specify filter parameters by setting configuration entries in the s

### Security

Gravitino Iceberg REST server supports OAuth2 and HTTPS, please refer to [Security](./security.md) for more details.
Gravitino Iceberg REST server supports OAuth2 and HTTPS, please refer to [Security](security/security.md) for more details.

### Storage

Expand Down
11 changes: 9 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,11 +144,18 @@ Gravitino provides a Flink connector to manage metadata in a unified way. To use

Gravitino provides several ways to configure and manage the Gravitino server. See:

* [Security](./security.md): provides security configurations for Gravitino, including HTTPS
and OAuth2 configurations.
* [Gravitino metrics](./metrics.md): provides metrics configurations and detailed a metrics list
of the Gravitino server.

### Security

Gravitino provides security configurations for Gravitino, including HTTPS, authentication and access control configurations.

* [HTTPS](./security/how-to-use-https.md): provides HTTPS configurations.
* [Authentication](./security/how-to-authenticate.md): provides authentication configurations including simple, OAuth, Kerberos.
* [Access Control](./security/access-control.md): provides access control configurations.
* [CORS](./security/how-to-use-cors.md): provides CORS configurations.

### Programming guides

* [Gravitino Open API](./api/rest/gravitino-rest-api): provides the complete Open API definition of
Expand Down
327 changes: 0 additions & 327 deletions docs/security.md

This file was deleted.

Loading

0 comments on commit 8293bed

Please sign in to comment.