Add infinit. #919

Dimrok · 2017-06-01T13:53:54Z

Add infinit documentation to the official images documentation (see docker-library/official-images#3005)

tianon

Looks generally OK, just a few notes so far. 👍

tianon · 2017-06-09T14:02:09Z

infinit/content.md

+
+On UNIX-based systems, Infinit uses `FUSE` to provide mount points. Hence, for UNIX-based containers, you need `FUSE` installed on your host (see Infinit's [get-started page](https://infinit.sh/get-started#installation)) and run Docker in privileged mode (`--privileged`).
+
+	docker run --privileged -e INFINIT_USER=$USER -v ~/.local/share/infinit:/root/.local/share/infinit --rm infinit # volume mount --name <VOLUME> --mountpoint <DIRECTORY>


For using FUSE inside a container, I think --privileged is a bit overkill (since it essentially allows all privileges of the host, instead of the strictly-necessary subset). Can we trim this down to just the subset necessary? I'd imagine something like --cap-add SYS_ADMIN --device /dev/fuse is probably pretty close to the actual set required.

tianon · 2017-06-09T14:02:38Z

infinit/content.md

+
+##### Others (object, block, etc.)
+
+At current version (0,7.3), the single logic exposed is the distributed file system but more logics will be added in the upcoming releases, such as an object storage logic, a block device logic and various interfaces for them.


Minor typo: 0,7.3 vs 0.7.3

tianon · 2017-06-09T14:03:20Z

infinit/github-repo

@@ -0,0 +1 @@
+http://github.com/infinit/infinit-docker


Can you swap this to use https please? (it'll redirect, but better to be explicit IMO)

tianon · 2017-06-09T14:04:03Z

infinit/license.md

@@ -0,0 +1 @@
+View [license information](https://www.infinit.sh/licenses/infinit.txt) for the software contained in this image.


This URL appears to be a 404. 😕

Waiting for the website to be deployed.

tianon · 2017-06-09T14:07:01Z

infinit/content.md

@@ -0,0 +1,67 @@
+Infinit’s storage platform transforms commodity servers into multiple flexible, scalable, secure and fault-tolerant storage logics tailored to your applications.


You probably want to include an h1 header above this, something like # Infinit or # What is Infinit? (similar to other images) or else this block will combine with the block in the template above it. If you run ./update.sh infinit it should generate infinit/README.md which you can then use to get an idea for how your generated content is going to flow (just don't commit that generated file -- we've got a bot that'll update it automatically after merge).

Also, that logo.png that's included here will only show up if %%LOGO%% is used somewhere here in the body. In other descriptions, we usually put it right after this initial "what is XYZ?" paragraph, but some maintainers prefer to list it either earlier or later -- it's really up to you. 👍

yosifkit

Requesting a few clarifications.

yosifkit · 2017-07-11T23:36:40Z

infinit/content.md

+
+### Using your user
+
+By default, Infinit uses the current user, `root` when running on a container. If you want to use your local user name, you can set the INFINIT_USER environment variable.


This line is a bit confusing. Does infinit use "the current user" or is it "root" "when running on a container"?

What does the INFINIT_USER environment variable do? If I pass in my linux username, it is not going to mean anything inside the container since it does not have my /etc/passwd to get a user id.

yosifkit · 2017-07-11T23:45:11Z

infinit/content.md

+
+On UNIX-based systems, Infinit uses `FUSE` to provide mount points. Hence, for UNIX-based containers, you need `FUSE` installed on your host (see Infinit's [get-started page](https://infinit.sh/get-started#installation)) and run Docker with specific options (`--cap-add SYS_ADMIN --device /dev/fuse`).
+
+	docker run --cap-add SYS_ADMIN --device /dev/fuse -e INFINIT_USER=$USER -v ~/.local/share/infinit:/root/.local/share/infinit --rm infinit volume mount --name <VOLUME> --mountpoint <DIRECTORY>


It looks like this docker run would use a share that was already created (--name) and mount it at --mountpoint; would this be available only for that container or is the mount point relative to the host mount namespace?

How would someone relate this to using infinit as a volume plugin: https://infinit.sh/documentation/docker/volume-plugin? I anticipate that this is what most people will want to use the image for, so it would be nice if there was a clear step-by-step process to go from "nothing" to "my swarm has access to share volumes via infinit".

Maybe it would need to mention where the silos are stored (/var/storage/infinit/) so that the inifinit plugin container will use the same local directory (-v /path/to/storage/:/var/storage/infinit/)?

It looks like this docker run would use a share that was already created (--name) and mount it at --mountpoint; would this be available only for that container or is the mount point relative to the host mount namespace?

The example uses a configuration folder (<blabl>/share/infinit) shared between the host and the container but the mountpoint will be available only for the container (but actually accessible somewhere hidden on the host like /run/user/0/infinit/filesystem/mnt/<xxx>). However everybody mounting the same volume elsewhere will have access to the same 'volume' and share data with the container.

[...] "my swarm has access to share volumes via infinit".

About swarm, because some options (privileged, add-cap, etc.) available for docker run are not available for docker service, this is not possible (yet?) to create fuse mount points in a swarm.

However, I guess I can write something about the infinit deamon in a container used by other containers.

I guess what I meant was making it a volume plugin on Docker and did not realize that plugins didn't work on swarm... until this next release!

So, it looks like volume plugins will work on swarm:

PR: Plugins on swarm moby/moby#33575

merge commit moby/moby@05c7c31

commit in docker-ce: docker/docker-ce@0887a18

So, 17.07.0-ce-rc1 and above will work for running this as a volume plugin on a swarm. And I think an example or link to getting it to work as a plugin on a single docker would help users immensely.

Thanks!

Dimrok · 2017-08-21T07:29:14Z

Great! I'll give it a try and write a comprehensive plugin integration example.

…

On Thu, Aug 10, 2017 at 8:27 PM, yosifkit ***@***.***> wrote: ***@***.**** commented on this pull request. ------------------------------ In infinit/content.md <#919 (comment)>: > + +### Using your user + +By default, Infinit uses the current user, `root` when running on a container. If you want to use your local user name, you can set the INFINIT_USER environment variable. + + docker run -e INFINIT_USER=$USER -v ~/.local/share/infinit:/root/.local/share/infinit --rm infinit + +### Accessing storage logics + +For now, the only logic available is a distributed file system. + +#### File system + +On UNIX-based systems, Infinit uses `FUSE` to provide mount points. Hence, for UNIX-based containers, you need `FUSE` installed on your host (see Infinit's [get-started page](https://infinit.sh/get-started#installation)) and run Docker with specific options (`--cap-add SYS_ADMIN --device /dev/fuse`). + + docker run --cap-add SYS_ADMIN --device /dev/fuse -e INFINIT_USER=$USER -v ~/.local/share/infinit:/root/.local/share/infinit --rm infinit volume mount --name <VOLUME> --mountpoint <DIRECTORY> I guess what I meant was making it a volume plugin on Docker and did not realize that plugins didn't work on swarm... until this next release! So, it looks like volume plugins will work on swarm: - PR: moby/moby#33575 <moby/moby#33575> - merge commit ***@***.*** <moby/moby@05c7c31> - commit in docker-ce: ***@***.*** <docker/docker-ce@0887a18> So, 17.07.0-ce-rc1 and above will work for running this as a volume plugin on a swarm. And I think an example or link to getting it to work as a plugin on a single docker would help users immensely. Thanks! — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#919 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/ADNCkKebElvk1bUTad5LNHqhs6AdVhmxks5sW0uBgaJpZM4NtA3U> .

tianon · 2018-05-21T22:37:04Z

Any update on the comments here? 🙏 ❤️

yosifkit · 2019-02-04T23:19:06Z

Closing since image PR is closed: docker-library/official-images#3005

Add infinit.

fcf56dc

Dimrok mentioned this pull request Jun 1, 2017

Add infinit. docker-library/official-images#3005

Closed

9 tasks

Antony MECHIN added 2 commits June 7, 2017 11:23

infinit: Reformat content.md.

edabc51

infinit: Reformat content.md using the latest markdownfmt.

fdb5e46

tianon reviewed Jun 9, 2017

View reviewed changes

infinit: Update documentation.

696734c

yosifkit reviewed Jul 11, 2017

View reviewed changes

yosifkit closed this Feb 4, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add infinit. #919

Add infinit. #919

Dimrok commented Jun 1, 2017

tianon left a comment

tianon Jun 9, 2017

tianon Jun 9, 2017

tianon Jun 9, 2017

tianon Jun 9, 2017

Dimrok Jun 21, 2017

Dimrok Jun 26, 2017

tianon Jun 9, 2017

yosifkit left a comment

yosifkit Jul 11, 2017

yosifkit Jul 11, 2017

yosifkit Jul 11, 2017

yosifkit Jul 11, 2017

Dimrok Jul 25, 2017 •

edited

yosifkit Aug 10, 2017

Dimrok commented Aug 21, 2017 via email

tianon commented May 21, 2018

yosifkit commented Feb 4, 2019


		On UNIX-based systems, Infinit uses `FUSE` to provide mount points. Hence, for UNIX-based containers, you need `FUSE` installed on your host (see Infinit's [get-started page](https://infinit.sh/get-started#installation)) and run Docker in privileged mode (`--privileged`).

		docker run --privileged -e INFINIT_USER=$USER -v ~/.local/share/infinit:/root/.local/share/infinit --rm infinit # volume mount --name <VOLUME> --mountpoint <DIRECTORY>


		##### Others (object, block, etc.)

		At current version (0,7.3), the single logic exposed is the distributed file system but more logics will be added in the upcoming releases, such as an object storage logic, a block device logic and various interfaces for them.

		@@ -0,0 +1 @@
		View [license information](https://www.infinit.sh/licenses/infinit.txt) for the software contained in this image.

		@@ -0,0 +1,67 @@
		Infinit’s storage platform transforms commodity servers into multiple flexible, scalable, secure and fault-tolerant storage logics tailored to your applications.


		### Using your user

		By default, Infinit uses the current user, `root` when running on a container. If you want to use your local user name, you can set the INFINIT_USER environment variable.


		On UNIX-based systems, Infinit uses `FUSE` to provide mount points. Hence, for UNIX-based containers, you need `FUSE` installed on your host (see Infinit's [get-started page](https://infinit.sh/get-started#installation)) and run Docker with specific options (`--cap-add SYS_ADMIN --device /dev/fuse`).

		docker run --cap-add SYS_ADMIN --device /dev/fuse -e INFINIT_USER=$USER -v ~/.local/share/infinit:/root/.local/share/infinit --rm infinit volume mount --name <VOLUME> --mountpoint <DIRECTORY>

		@@ -0,0 +1 @@
		http://github.com/infinit/infinit-docker

Add infinit. #919

Add infinit. #919

Conversation

Dimrok commented Jun 1, 2017

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

yosifkit 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

Dimrok Jul 25, 2017 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Dimrok commented Aug 21, 2017 via email

tianon commented May 21, 2018

yosifkit commented Feb 4, 2019

Dimrok Jul 25, 2017 •

edited