Skip to content

Update InfluxDB Docker content.md #2586

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

Open
wants to merge 41 commits into
base: master
Choose a base branch
from

Conversation

MeelahMe
Copy link

This PR updates the Docker README file to clarify instructions for running the server in a container.
Changes include:

  • Adding clearer steps to activate a trial or home license when using Docker
  • Providing an example for skipping the email prompt
  • Improving formatting for better readability

@MeelahMe MeelahMe marked this pull request as draft June 18, 2025 15:50
@MeelahMe MeelahMe marked this pull request as ready for review June 18, 2025 22:51
Copy link
Contributor

Choose a reason for hiding this comment

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

  • The overview paragraph should stay general for InfluxDB (not specific to InfluxDB 3).
  • If docker-library doesn't generate or support a TOC, we need to be clear that the readme contains info for all 3 versions.
  • We need to make sure we don't lose any existing instructions. I see you're linking to the v1 and v2 docs, which is good, but we need to verify they're comprehensive.

Copy link
Contributor

Choose a reason for hiding this comment

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

The sample compose.yaml for all 3 would be nice to have.

@MeelahMe MeelahMe changed the title Update Docker README and usage instructions Update InfluxDB Docker content.md Jun 26, 2025
Copy link
Contributor

@jstirnaman jstirnaman left a comment

Choose a reason for hiding this comment

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

@MeelahMe Some fixes and suggestions.

-v $PWD/data:/var/lib/influxdb3 \
-e INFLUX_LICENSE_KEY="YOUR_LICENSE_KEY" \
influxdb:enterprise serve \
--cluster-id cluster1 \
Copy link
Contributor

Choose a reason for hiding this comment

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

We should have an example using available environment variables, specific for Docker startup (if any) and InfluxDB3 variables. Users will want to source them from a file (.env, for example)

%%IMAGE%%:1.8 /init-influxdb.sh
docker run -d -p 8086:8086 \
-v $PWD:/var/lib/influxdb \
influxdb:1.8
```
Copy link
Contributor

Choose a reason for hiding this comment

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

For v1 and v2, we should keep the examples with the startup config env variables. Most users will want those.

@jstirnaman
Copy link
Contributor

jstirnaman commented Jul 2, 2025 via email

%%IMAGE%%:1.8
docker run -d --name influxdb3-core \
-v influxdb3-data:/var/lib/influxdb3 \
-p 8086:8086 \
Copy link
Contributor

Choose a reason for hiding this comment

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

...unless you set it explicitly. We should just use the default in this README.

@MeelahMe MeelahMe force-pushed the docs/docker-readme-update branch from 1e46d19 to 9c1a306 Compare July 3, 2025 13:52
ruffsl and others added 2 commits July 3, 2025 07:25
* Remove references to dedicated ROS distros
as final ROS 1 version, Noetic, is now EOL

* Redirect primary links to documentation landing page
as docs page is more up-to-date and pertinent for users

* Remove retired ROS blog
- https://www.ros.org/news/2020/01/ros-blog-retired.html

* Update OSRF URL redirect

* Update example image tag to rolling
to avoid docs from becoming stale

* Consolidate branding and dated references

* Update Q&A links to stackexchange given migration
- https://discourse.ros.org/t/planned-migration-of-ros-answers-and-gazebo-answers-to-robotics-stack-exchange/28068
- https://discourse.ros.org/t/new-static-archives-for-ros-and-gazebo-answers/41346

* Simplify cloning overlay source

* Simplify use of mixin setting

* Split runner and builder stages
as example to save on image size
as well as on build time using caching

* Simplify scripting for dependencies

* Lint use of ARGs
for readability of each stage

* Simplify example cache mount for apt
and update rosdep along with apt list
to ensure package index is fresh

* Update categories for ROS
to include additional relevant entries

* Shorten derivation script

* Use ros-core tag for minimal installer

* Stage example image sizes for demos

* Simplify naming

* Omit cacher from size table
to focus on primary targets

* Modify and mount custom apt config
accounting for included docker-clean default

* Simplify RUN directive for apt config

* Stage WIP edits

* Update package cache before cloning source
to avoid running rosdep update for each source change
as docker build --no-cache can still be used to force update

* Fix use of EOF in Dockerfile

* Simply RUN directives

* Expand bullet points about optimizations

* Expand upon runner vs installer comparison

* Linting

* Fix grammar and spelling

* Linting

* Rename stage in apt get example
while keeping with uniquely spelled noun
that is self descriptive yet unmistakable

* Comment on overwriting defaults to persist minimal cache
@MeelahMe MeelahMe force-pushed the docs/docker-readme-update branch from 52789b3 to 7b257f1 Compare July 3, 2025 14:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants