Skip to content

update experimental/README.md#28160

Merged
thaJeztah merged 1 commit intomoby:masterfrom
AkihiroSuda:update-experimental-md
Dec 18, 2016
Merged

update experimental/README.md#28160
thaJeztah merged 1 commit intomoby:masterfrom
AkihiroSuda:update-experimental-md

Conversation

@AkihiroSuda
Copy link
Member

@AkihiroSuda AkihiroSuda commented Nov 8, 2016

Signed-off-by: Akihiro Suda [email protected]

@AkihiroSuda
Copy link
Member Author

cc @mlaventure @icecrime

Copy link
Member

Choose a reason for hiding this comment

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

Perhaps we should explain how to set it through the daemon.json file instead? That way, we don't have to explain how to create a drop-in file for systemd, and how to daemon-reload etc

Copy link
Contributor

Choose a reason for hiding this comment

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

Probably a good thing to have both.

I'd make it more generic by stating that the service file for docker needs to be updated.

Not everyone has moved to systemd yet (present company included :))

Copy link
Member Author

Choose a reason for hiding this comment

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

done

@mlaventure
Copy link
Contributor

cc @andrewhsu

@AkihiroSuda AkihiroSuda force-pushed the update-experimental-md branch from d038cfe to d2db354 Compare November 8, 2016 16:35
@thaJeztah thaJeztah added this to the 1.13.0 milestone Nov 8, 2016
@andrewhsu
Copy link
Contributor

@AkihiroSuda for the upcoming release, we're going to keep the existing endpoints up for installing experimental so we need the instructions. We're also going to need the DOCKER_EXPERIMENTAL environment variable to build a separate experimental RPM with experimental flag enabled by default. So, I'd say don't change the build-rpm file.

If you want to keep the section you add to the README.md and not delete the Install Docker experimental section, that would be valuable.

@AkihiroSuda AkihiroSuda force-pushed the update-experimental-md branch from d2db354 to 0d24211 Compare November 9, 2016 02:53
@AkihiroSuda AkihiroSuda changed the title Update files related to EXPERIMENTAL Enable exp features by default if built with DOCKER_EXPERIMENTAL Nov 9, 2016
@AkihiroSuda
Copy link
Member Author

AkihiroSuda commented Nov 9, 2016

@andrewhsu

OK, entirely changed PR.

Now it enables experimental features by default if the binary is built with DOCKER_EXPERIMENTAL.

  • experimental.docker.com will provide the binary with experimental features enabled by default. I believe the admin for experimental.docker.com has no additional task for that.
  • build-rpm is not changed, and can provide the binary with experimental features enabled by default if DOCKER_EXPERIMENTAL is set
  • experimental/README.md mentions both experimental-by-default binary and regular binary.

@AkihiroSuda
Copy link
Member Author

cc @mlaventure @icecrime

@andrewhsu
Copy link
Contributor

@AkihiroSuda what you had for just the README.md looks like it is worthwhile for review and can be treated independently. If you just have that in a PR it looks like it can be merged in faster.

As for enabling experimental by default upon install of a docker-engine package...the code should already be in master branch for reading the daemon.json config file and checking for experimental flag. So, no need to create another build flag experimentalbydefault.

The DOCKER_EXPERIMENTAL=1 value is passed in to docker-engine.spec via build-rpm. The docker-engine.spec file will need an if-then stmt based on this value to add an entry to daemon.json to build the package with experimental enabled by default upon install. @mlaventure had identified this in #27788.

@AkihiroSuda AkihiroSuda force-pushed the update-experimental-md branch from 0d24211 to eef9534 Compare November 9, 2016 06:55
@AkihiroSuda AkihiroSuda changed the title Enable exp features by default if built with DOCKER_EXPERIMENTAL update experimental/README.md Nov 9, 2016
@AkihiroSuda
Copy link
Member Author

@andrewhsu OK, updated PR to only contain experimental/README.md

Copy link
Member Author

Choose a reason for hiding this comment

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

I removed this line because make binary doesn't produce daemon.json with the experimental flag.

Copy link
Member Author

Choose a reason for hiding this comment

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

I removed this line because IIUC tgz is unlikely to contain daemon.json with the experimental flag.
Maybe we should mention RPM (and DEB, right?) here later.

Copy link
Contributor

Choose a reason for hiding this comment

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

The experimental package is built on the same schedule as the regular Docker binary now, this part also needs to be updated

Copy link
Contributor

Choose a reason for hiding this comment

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

Perhaps wording along the lines of:

Experimental features are now included in the standard docker binaries as of version 1.13.0.

Copy link
Contributor

Choose a reason for hiding this comment

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

Also tweaking of wording s/From one day to the next/From one release to the next/

Copy link
Member Author

Choose a reason for hiding this comment

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

done

@AkihiroSuda AkihiroSuda force-pushed the update-experimental-md branch from eef9534 to 8a02480 Compare November 11, 2016 09:44
If you install Docker from `experimental.docker.com`, the experimental features
are enabled by default.
The experimental package available at `experimental.docker.com` is almost
identical to the standard Docker package, but it contains `daemon.json` for
Copy link
Contributor

Choose a reason for hiding this comment

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

@andrewhsu is that going to be the case or are we going to use the cli flag?

Copy link
Member Author

Choose a reason for hiding this comment

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

PTAL @andrewhsu

Copy link
Member Author

Choose a reason for hiding this comment

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

#28194 (comment)

There will not be a release of experimental binaries for the 1.13.0 GA, so no need to create work for making sure the binaries are released.

Should we just remove this subsection?
PTAL @andrewhsu

@LK4D4
Copy link
Contributor

LK4D4 commented Nov 30, 2016

ping @andrewhsu

@AkihiroSuda
Copy link
Member Author

#29389

There will not be a release of experimental binaries for the 1.13.0 GA

Updated PR according to this.

@AkihiroSuda AkihiroSuda force-pushed the update-experimental-md branch from 8a02480 to 3dce3c3 Compare December 15, 2016 15:32
Copy link
Member

Choose a reason for hiding this comment

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

looks like this is still using 8 spaces for indentation (which is no longer needed because the numbered list is gone).
while updating, can you use "fences" for this block, and a JSON code-hint? i.e.

```json
{
    "experimental":true
}
```

Copy link
Member

Choose a reason for hiding this comment

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

same here, but with a bash type hint

Signed-off-by: Akihiro Suda <[email protected]>
@AkihiroSuda AkihiroSuda force-pushed the update-experimental-md branch from 3dce3c3 to eb11a10 Compare December 16, 2016 04:03
@AkihiroSuda
Copy link
Member Author

done @thaJeztah

Copy link
Member

@thaJeztah thaJeztah left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

Copy link
Member

@vdemeester vdemeester left a comment

Choose a reason for hiding this comment

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

LGTM 🐸

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

9 participants