influxdata / influxdata/docs-v2
Clarify purpose of `INFLUXDB3_TLS_CA` environment variable
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 82
- Forks
- 326
- Avg merge
- 1d 1h
- Merged PRs (30d)
- 82
Description
### Problem
In https://github.com/influxdata/influxdb/issues/26727 it was pointed out that use for the `INFLUXDB3_TLS_CA` is not clear in the [release notes](https://docs.influxdata.com/influxdb3/enterprise/release-notes/#core-5).
The user thought that setting this variable would affect communication made with, e.g., the external object store (S3) from their running service.
### Proposed solution
Update the [release notes](https://docs.influxdata.com/influxdb3/enterprise/release-notes/#core-5) to clarify that the `--tls-ca` argument is not intended for the `influxdb3 serve` command, but is instead intended for other `influxdb3` commands, e.g., `create`, `write`, `query`, etc., that interact with the running `influxdb3` server started with `influxdb3 serve` and a self-signed certificate.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open the InfluxDB 3 Enterprise release notes at the Core 5 section and review the existing explanation of INFLUXDB3_TLS_CA and --tls-ca. Clarify that the option is for client commands such as create, write, and query connecting to a self-signed influxdb3 serve server, not for the server's external object-store communication.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100