Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[MINOR] fix(docs): Modify the required value for the document security.md #1214

Merged
merged 3 commits into from
Dec 20, 2023

Conversation

qqqttt123
Copy link
Contributor

@qqqttt123 qqqttt123 commented Dec 20, 2023

What changes were proposed in this pull request?

Modify the required value for the document security.md.
I modify some document mistakes by the way.

Why are the changes needed?

According the review #1191 (comment) , modify the required value. If a config option has a default value, this config option is not required.

Does this PR introduce any user-facing change?

No.

How was this patch tested?

No need.

| `gravitino.auxService.iceberg-rest.managerPassword` | Manager password to the key store. | (none) | Yes if use HTTPS | 0.3.0 |
| `gravitino.auxService.iceberg-rest.tlsProtocol` | TLS protocol to use. The JVM must support the TLS protocol to use. | (none) | Yes if use HTTPS | 0.3.0 |
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This config option should be optional. I correct it by the way.

| `gravitino.server.webserver.enableCipherAlgorithms` | The collection of enabled cipher algorithms. | `` | No | 0.3.0 |
| `gravitino.server.webserver.enableClientAuth` | Enables the authentication of the client. | `false` | No | 0.3.0 |
| `gravitino.server.webserver.trustStorePath` | Path to the trust store file. | (none) | Yes if use HTTPS and the authentication of client | 0.3.0 |
| `gravitino.server.webserver.trustStorePassword` | Password to the trust store. | (none) | Yes if use HTTPS and the authentication of client | 0.3.0 |
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I missed (). I add it back by the way.

| `gravitino.server.webserver.tlsProtocol` | TLS protocol to use. The JVM must support the TLS protocol to use. | (none) | No | 0.3.0 |
| `gravitino.server.webserver.enableCipherAlgorithms` | The collection of enabled cipher algorithms. | `` | No | 0.3.0 |
| `gravitino.server.webserver.enableClientAuth` | Enables the authentication of the client. | `false` | No | 0.3.0 |
| `gravitino.server.webserver.trustStorePath` | Path to the trust store file. | (none) | Yes if use HTTPS and the authentication of client | 0.3.0 |
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I missed (). I add it back by the way.

@qqqttt123 qqqttt123 added branch-0.3 need backport Issues that need to backport to another branch labels Dec 20, 2023
@jerryshao jerryshao merged commit 3175f67 into apache:main Dec 20, 2023
4 checks passed
github-actions bot pushed a commit that referenced this pull request Dec 20, 2023
…ty.md` (#1214)

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

Modify the required value for the document `security.md`.
I modify some document mistakes by the way.

### Why are the changes needed?

According the review
#1191 (comment)
, modify the required value. If a config option has a default value,
this config option is not required.

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

### How was this patch tested?
No need.

---------

Co-authored-by: Heng Qin <[email protected]>
@qqqttt123 qqqttt123 deleted the minor_document branch December 22, 2023 12:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
need backport Issues that need to backport to another branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants