Initial commitment of documentation for clickhouse official image #2397

Felixoid · 2023-12-06T13:57:02Z

Hello, dear official library team. Here's our attempt to create an official image clickhouse in the scope of docker-library/official-images#14136 and ClickHouse/ClickHouse#31473

Both the docs and official images PRs are created simultaneously.

docker-library/official-images#15846

Felixoid · 2024-05-10T11:42:31Z

The content.md + license.md are the same as docker/server/README.md in ClickHouse/ClickHouse#63400

tianon · 2024-11-07T19:18:08Z

Close/reopen to retrigger fresh GHA checks 👍

Felixoid · 2024-11-07T19:39:49Z

It looks like I missed some metadata.json there. I'll read what it is.

tianon

CI is complaining about metadata.json, which is new since you opened this -- I think something like the following is probably the contents you'll want, but if you'd rather just leave that I'm happy to ignore the failing CI and take care of that myself out-of-band (your choice):

{
  "hub": {
    "categories": [
      "databases-and-storage"
    ]
  }
}

clickhouse/content.md

tianon · 2024-11-07T19:42:49Z

clickhouse/content.md

+### connect to it from a native client
+
+```bash
+docker run -it --rm --link some-clickhouse-server:clickhouse-server --entrypoint clickhouse-client clickhouse/clickhouse-server --host clickhouse-server


I would not recommend adding new documentation referencing --link (it is deprecated; see https://docs.docker.com/engine/network/links/ and #1441), but it's up to you -- the image reference needs to be correct though:

Suggested change

docker run -it --rm --link some-clickhouse-server:clickhouse-server --entrypoint clickhouse-client clickhouse/clickhouse-server --host clickhouse-server

docker run -it --rm --link some-clickhouse-server:clickhouse-server --entrypoint clickhouse-client %%IMAGE%% --host clickhouse-server

Getting rid of --link would require some good replacement, and off the top of my head, the docker network juggling doesn't give an easy-to-use alternative.

Can you suggest something here?

#1441 was the best I could come up with (without having a common blurb for every image trying to explain Docker Networks), but it's very "go read the manual" so I'm not super happy about it either (I really like the --link feature, fwiw 😭)

If you'd rather keep --link that is OK 👍

tianon · 2024-11-07T19:46:12Z

clickhouse/content.md

+-	The amd64 image requires support for [SSE3 instructions](https://en.wikipedia.org/wiki/SSE3). Virtually all x86 CPUs after 2005 support SSE3.
+-	The arm64 image requires support for the [ARMv8.2-A architecture](https://en.wikipedia.org/wiki/AArch64#ARMv8.2-A) and additionally the Load-Acquire RCpc register. The register is optional in version ARMv8.2-A and mandatory in [ARMv8.3-A](https://en.wikipedia.org/wiki/AArch64#ARMv8.3-A). Supported in Graviton >=2, Azure and GCP instances. Examples for unsupported devices are Raspberry Pi 4 (ARMv8.0-A) and Jetson AGX Xavier/Orin (ARMv8.2-A).


As the author of opencontainers/image-spec@2d95dde, I love this -- I wish we had a way to specify that the amd64 image variant should be v2 (corresponding to the lowest level with SSE3) and the arm64 variant could be v8.2, but we don't currently have a way to specify either in our system and the latter would break folks (until containerd/platforms#8 and similar trickle down to popular runtimes), so for now I'm just happy to see it documented explicitly (hopefully ClickHouse also reports a clear error when these are missing). 😄 ❤️

clickhouse/content.md

tianon · 2024-11-07T19:53:19Z

clickhouse/content.md

+They are optional and can be enabled using the following [docker command-line arguments](https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities):
+
+```bash
+docker run -d \
+    --cap-add=SYS_NICE --cap-add=NET_ADMIN --cap-add=IPC_LOCK \


Given that they're optional, you don't happen to have any documentation about what each of these are used for and when/why users might want to set them (specific to ClickHouse behavior), do you?

Hmm, is this URL worth adding here?

The line is added below:

Read more in [knowledge base](https://clickhouse.com/docs/knowledgebase/configure_cap_ipc_lock_and_cap_sys_nice_in_docker).

Yeah, for sure! I wonder if it could be improved to explain why, but that's not a blocker at all, just something I think would be useful. 😄 ❤️

There's a part of the ClickHouse logs related to the capabilities on the KB page:

2023.04.19 08:04:10.022720 [ 1 ] {} <Information> Application: It looks like the process has no CAP_IPC_LOCK capability, binary mlock will be disabled. It could happen due to incorrect ClickHouse package installation. You could resolve the problem manually with 'sudo setcap cap_ipc_lock=+ep /usr/bin/clickhouse'. Note that it will not work on 'nosuid' mounted filesystems.

2023.04.19 08:04:10.065860 [ 1 ] {} <Information> Application: It looks like the process has no CAP_SYS_NICE capability, the setting 'os_thread_priority' will have no effect. It could happen due to incorrect ClickHouse package installation. You could resolve the problem manually with 'sudo setcap cap_sys_nice=+ep /usr/bin/clickhouse'. Note that it will not work on 'nosuid' mounted filesystems.

Should I add it as well explicitly?

Naw, I think what you've got now is fine. 👍

clickhouse/content.md

Felixoid

For the rest, I'll try to build a limited version of your update.sh in our repo to have compatibility between repos. Will be back in a moment

clickhouse/content.md

Felixoid · 2024-11-08T08:22:50Z

clickhouse/content.md

+They are optional and can be enabled using the following [docker command-line arguments](https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities):
+
+```bash
+docker run -d \
+    --cap-add=SYS_NICE --cap-add=NET_ADMIN --cap-add=IPC_LOCK \


Hmm, is this URL worth adding here?

clickhouse/content.md

Felixoid

The --link is only question, I think

clickhouse/content.md

Felixoid · 2024-11-08T12:00:59Z

clickhouse/content.md

+### connect to it from a native client
+
+```bash
+docker run -it --rm --link some-clickhouse-server:clickhouse-server --entrypoint clickhouse-client clickhouse/clickhouse-server --host clickhouse-server


Getting rid of --link would require some good replacement, and off the top of my head, the docker network juggling doesn't give an easy-to-use alternative.

Can you suggest something here?

Felixoid · 2024-11-08T12:05:11Z

clickhouse/content.md

+They are optional and can be enabled using the following [docker command-line arguments](https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities):
+
+```bash
+docker run -d \
+    --cap-add=SYS_NICE --cap-add=NET_ADMIN --cap-add=IPC_LOCK \


The line is added below:

Read more in [knowledge base](https://clickhouse.com/docs/knowledgebase/configure_cap_ipc_lock_and_cap_sys_nice_in_docker).

tianon

Only a couple really minor things 👀

clickhouse/content.md

tianon · 2024-11-08T20:11:49Z

clickhouse/github-repo

@@ -0,0 +1 @@
+https://github.com/ClickHouse/docker-library


Mostly an FYI, this will get used for things like links in the "Quick Reference" section to GitHub issues -- is this where you want users to file issues related to the image, or would you rather they go to ClickHouse/ClickHouse? (do you plan to keep issues enabled on the docker-library repository?)

I misinterpret the readme, it should be the ClickHouse/ClickHouse for sure

Felixoid · 2024-11-08T21:22:34Z

Oh, my chaos, my chaos, my chaos! Did we finish it? What's next?

I am so excited ^_^

tianon · 2024-11-08T21:32:41Z

(as noted in docker-library/official-images#15846 (comment), just waiting for @yosifkit to give me another set of eyes 🤞)

Felixoid · 2024-11-09T09:19:33Z

@tianon "funny" aftermath. I haven't found that the 24.10 is built on top of jammy, AKA 22.04, so the https://github.com/docker-library/docs/pull/2397/files#diff-6a2321fc3b812fb166b7184bef1475db0c18919ad2612b02e06429f4cc986fc4R17 is not valid. I'll fix it in the follow-up PR to the library, where I will make this version FROM ubuntu:20.04.

update: addressed the issue with 24.10's base in docker-library/official-images#17876

This was referenced Dec 6, 2023

Initial commitment of clickhouse official image docker-library/official-images#15846

Merged

Provide clickhouse/clickhouse-server image as the official image docker-library/official-images#14136

Closed

tianon closed this Nov 7, 2024

tianon reopened this Nov 7, 2024

tianon reviewed Nov 7, 2024

View reviewed changes

Initial commitment of documentation for clickhouse official image

3f53215

Felixoid force-pushed the master branch from 18a24f8 to 3f53215 Compare November 7, 2024 20:05

Add metadata.json

aa7bbcb

Felixoid commented Nov 8, 2024

View reviewed changes

Apply review comments

a8f1708

Felixoid commented Nov 8, 2024

View reviewed changes

tianon reviewed Nov 8, 2024

View reviewed changes

Another review round

d0b8623

tianon approved these changes Nov 8, 2024

View reviewed changes

tianon assigned yosifkit Nov 8, 2024

yosifkit approved these changes Nov 8, 2024

View reviewed changes

yosifkit merged commit 007e320 into docker-library:master Nov 8, 2024
6 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Initial commitment of documentation for clickhouse official image #2397

Initial commitment of documentation for clickhouse official image #2397

Felixoid commented Dec 6, 2023 •

edited

Loading

Felixoid commented May 10, 2024

tianon commented Nov 7, 2024

Felixoid commented Nov 7, 2024

tianon left a comment

tianon Nov 7, 2024

Felixoid Nov 8, 2024

tianon Nov 8, 2024

tianon Nov 7, 2024

tianon Nov 7, 2024

Felixoid Nov 8, 2024

Felixoid Nov 8, 2024

tianon Nov 8, 2024

Felixoid Nov 8, 2024

tianon Nov 8, 2024

Felixoid left a comment

Felixoid Nov 8, 2024

Felixoid left a comment

Felixoid Nov 8, 2024

Felixoid Nov 8, 2024

tianon left a comment

tianon Nov 8, 2024

Felixoid Nov 8, 2024

Felixoid commented Nov 8, 2024

tianon commented Nov 8, 2024

Felixoid commented Nov 9, 2024 •

edited

Loading

	docker run -it --rm --link some-clickhouse-server:clickhouse-server --entrypoint clickhouse-client clickhouse/clickhouse-server --host clickhouse-server
	docker run -it --rm --link some-clickhouse-server:clickhouse-server --entrypoint clickhouse-client %%IMAGE%% --host clickhouse-server

		- The amd64 image requires support for [SSE3 instructions](https://en.wikipedia.org/wiki/SSE3). Virtually all x86 CPUs after 2005 support SSE3.
		- The arm64 image requires support for the [ARMv8.2-A architecture](https://en.wikipedia.org/wiki/AArch64#ARMv8.2-A) and additionally the Load-Acquire RCpc register. The register is optional in version ARMv8.2-A and mandatory in [ARMv8.3-A](https://en.wikipedia.org/wiki/AArch64#ARMv8.3-A). Supported in Graviton >=2, Azure and GCP instances. Examples for unsupported devices are Raspberry Pi 4 (ARMv8.0-A) and Jetson AGX Xavier/Orin (ARMv8.2-A).

		@@ -0,0 +1 @@
		https://github.com/ClickHouse/docker-library

Initial commitment of documentation for clickhouse official image #2397

Initial commitment of documentation for clickhouse official image #2397

Conversation

Felixoid commented Dec 6, 2023 • edited Loading

Felixoid commented May 10, 2024

tianon commented Nov 7, 2024

Felixoid commented Nov 7, 2024

tianon left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Felixoid left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Felixoid left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tianon left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Felixoid commented Nov 8, 2024

tianon commented Nov 8, 2024

Felixoid commented Nov 9, 2024 • edited Loading

Felixoid commented Dec 6, 2023 •

edited

Loading

Felixoid commented Nov 9, 2024 •

edited

Loading