[DISCUSS] FLINK-15831: Add Docker image publication to release documentation

[Patrick Lucas-2]

Hi all,

For FLINK-15831[1], I think the way to start is for the flink-docker
repo[2] itself to sufficiently document the workflow for publishing new
Dockerfiles, and then update the Flink release guide in the wiki to refer
to this documentation and to include this step in the "Finalize the
release" checklist.

To the first point, I have opened a PR[3] on flink-docker to improve its
documentation.

And for updating the release guide, I propose the following changes:

1. Add a new subsection to "Finalize the release", prior to "Checklist to
proceed to the next step" with the following content:

Publish the Dockerfiles for the new release

>
> Note: the official Dockerfiles fetch the binary distribution of the target
> Flink version from an Apache mirror. After publishing the binary release
> artifacts, mirrors can take some hours to start serving the new artifacts,
> so you may want to wait to do this step until you are ready to continue
> with the "Promote the release" steps below.
>
> Follow the instructions in the [flink-docker] repo to build the new
> Dockerfiles and send an updated manifest to Docker Hub so the new images
> are built and published.
>

2. Add an entry to the "Checklist to proceed to the next step" subsection
of "Finalize the release":

>
>    - Dockerfiles in flink-docker updated for the new Flink release and
>    pull request opened on the Docker official-images with an updated manifest
>
> Please let me know if you have any questions or suggestions to improve
this proposal.

Thanks,
Patrick

[1]https://issues.apache.org/jira/browse/FLINK-15831
[2]https://github.com/apache/flink-docker
[3]https://github.com/apache/flink-docker/pull/5

[Till Rohrmann]

Sounds good to me Patrick. +1 for these changes.

Cheers,
Till

On Fri, Feb 7, 2020 at 3:25 PM Patrick Lucas <[hidden email]> wrote:

> Hi all,
>
> For FLINK-15831[1], I think the way to start is for the flink-docker
> repo[2] itself to sufficiently document the workflow for publishing new
> Dockerfiles, and then update the Flink release guide in the wiki to refer
> to this documentation and to include this step in the "Finalize the
> release" checklist.
>
> To the first point, I have opened a PR[3] on flink-docker to improve its
> documentation.
>
> And for updating the release guide, I propose the following changes:
>
> 1. Add a new subsection to "Finalize the release", prior to "Checklist to
> proceed to the next step" with the following content:
>
> Publish the Dockerfiles for the new release
> >
> > Note: the official Dockerfiles fetch the binary distribution of the
> target
> > Flink version from an Apache mirror. After publishing the binary release
> > artifacts, mirrors can take some hours to start serving the new
> artifacts,
> > so you may want to wait to do this step until you are ready to continue
> > with the "Promote the release" steps below.
> >
> > Follow the instructions in the [flink-docker] repo to build the new
> > Dockerfiles and send an updated manifest to Docker Hub so the new images
> > are built and published.
> >
>
> 2. Add an entry to the "Checklist to proceed to the next step" subsection
> of "Finalize the release":
>
> >
> >    - Dockerfiles in flink-docker updated for the new Flink release and
> >    pull request opened on the Docker official-images with an updated
> manifest
> >
> > Please let me know if you have any questions or suggestions to improve
> this proposal.
>
> Thanks,
> Patrick
>
> [1]https://issues.apache.org/jira/browse/FLINK-15831
> [2]https://github.com/apache/flink-docker
> [3]https://github.com/apache/flink-docker/pull/5
>

[Yang Wang]

+1 to make flink-docker repository self-contained, including the document.
And others refer
to it.


Best,
Yang

Till Rohrmann <[hidden email]> 于2020年2月9日周日 下午5:35写道：

> Sounds good to me Patrick. +1 for these changes.
>
> Cheers,
> Till
>
> On Fri, Feb 7, 2020 at 3:25 PM Patrick Lucas <[hidden email]>
> wrote:
>
> > Hi all,
> >
> > For FLINK-15831[1], I think the way to start is for the flink-docker
> > repo[2] itself to sufficiently document the workflow for publishing new
> > Dockerfiles, and then update the Flink release guide in the wiki to refer
> > to this documentation and to include this step in the "Finalize the
> > release" checklist.
> >
> > To the first point, I have opened a PR[3] on flink-docker to improve its
> > documentation.
> >
> > And for updating the release guide, I propose the following changes:
> >
> > 1. Add a new subsection to "Finalize the release", prior to "Checklist to
> > proceed to the next step" with the following content:
> >
> > Publish the Dockerfiles for the new release
> > >
> > > Note: the official Dockerfiles fetch the binary distribution of the
> > target
> > > Flink version from an Apache mirror. After publishing the binary
> release
> > > artifacts, mirrors can take some hours to start serving the new
> > artifacts,
> > > so you may want to wait to do this step until you are ready to continue
> > > with the "Promote the release" steps below.
> > >
> > > Follow the instructions in the [flink-docker] repo to build the new
> > > Dockerfiles and send an updated manifest to Docker Hub so the new
> images
> > > are built and published.
> > >
> >
> > 2. Add an entry to the "Checklist to proceed to the next step" subsection
> > of "Finalize the release":
> >
> > >
> > >    - Dockerfiles in flink-docker updated for the new Flink release and
> > >    pull request opened on the Docker official-images with an updated
> > manifest
> > >
> > > Please let me know if you have any questions or suggestions to improve
> > this proposal.
> >
> > Thanks,
> > Patrick
> >
> > [1]https://issues.apache.org/jira/browse/FLINK-15831
> > [2]https://github.com/apache/flink-docker
> > [3]https://github.com/apache/flink-docker/pull/5
> >
>

[Ufuk Celebi-2]

+1 to have the README as source of truth and link to the repository from
the Wiki page.

– Ufuk


On Mon, Feb 10, 2020 at 3:48 AM Yang Wang <[hidden email]> wrote:

> +1 to make flink-docker repository self-contained, including the document.
> And others refer
> to it.
>
>
> Best,
> Yang
>
> Till Rohrmann <[hidden email]> 于2020年2月9日周日 下午5:35写道：
>
> > Sounds good to me Patrick. +1 for these changes.
> >
> > Cheers,
> > Till
> >
> > On Fri, Feb 7, 2020 at 3:25 PM Patrick Lucas <[hidden email]>
> > wrote:
> >
> > > Hi all,
> > >
> > > For FLINK-15831[1], I think the way to start is for the flink-docker
> > > repo[2] itself to sufficiently document the workflow for publishing new
> > > Dockerfiles, and then update the Flink release guide in the wiki to
> refer
> > > to this documentation and to include this step in the "Finalize the
> > > release" checklist.
> > >
> > > To the first point, I have opened a PR[3] on flink-docker to improve
> its
> > > documentation.
> > >
> > > And for updating the release guide, I propose the following changes:
> > >
> > > 1. Add a new subsection to "Finalize the release", prior to "Checklist
> to
> > > proceed to the next step" with the following content:
> > >
> > > Publish the Dockerfiles for the new release
> > > >
> > > > Note: the official Dockerfiles fetch the binary distribution of the
> > > target
> > > > Flink version from an Apache mirror. After publishing the binary
> > release
> > > > artifacts, mirrors can take some hours to start serving the new
> > > artifacts,
> > > > so you may want to wait to do this step until you are ready to
> continue
> > > > with the "Promote the release" steps below.
> > > >
> > > > Follow the instructions in the [flink-docker] repo to build the new
> > > > Dockerfiles and send an updated manifest to Docker Hub so the new
> > images
> > > > are built and published.
> > > >
> > >
> > > 2. Add an entry to the "Checklist to proceed to the next step"
> subsection
> > > of "Finalize the release":
> > >
> > > >
> > > >    - Dockerfiles in flink-docker updated for the new Flink release
> and
> > > >    pull request opened on the Docker official-images with an updated
> > > manifest
> > > >
> > > > Please let me know if you have any questions or suggestions to
> improve
> > > this proposal.
> > >
> > > Thanks,
> > > Patrick
> > >
> > > [1]https://issues.apache.org/jira/browse/FLINK-15831
> > > [2]https://github.com/apache/flink-docker
> > > [3]https://github.com/apache/flink-docker/pull/5
> > >
> >
>

[Patrick Lucas-2]

Thanks for the feedback.

Could someone (Ufuk or Till?) grant me access to to the FLINK space
Confluence so I can make these changes? My Confluence username is plucas.

Thanks,
Patrick

On Mon, Feb 10, 2020 at 9:54 AM Ufuk Celebi <[hidden email]> wrote:

> +1 to have the README as source of truth and link to the repository from
> the Wiki page.
>
> – Ufuk
>
>
> On Mon, Feb 10, 2020 at 3:48 AM Yang Wang <[hidden email]> wrote:
>
>> +1 to make flink-docker repository self-contained, including the document.
>> And others refer
>> to it.
>>
>>
>> Best,
>> Yang
>>
>> Till Rohrmann <[hidden email]> 于2020年2月9日周日 下午5:35写道：
>>
>> > Sounds good to me Patrick. +1 for these changes.
>> >
>> > Cheers,
>> > Till
>> >
>> > On Fri, Feb 7, 2020 at 3:25 PM Patrick Lucas <[hidden email]>
>> > wrote:
>> >
>> > > Hi all,
>> > >
>> > > For FLINK-15831[1], I think the way to start is for the flink-docker
>> > > repo[2] itself to sufficiently document the workflow for publishing
>> new
>> > > Dockerfiles, and then update the Flink release guide in the wiki to
>> refer
>> > > to this documentation and to include this step in the "Finalize the
>> > > release" checklist.
>> > >
>> > > To the first point, I have opened a PR[3] on flink-docker to improve
>> its
>> > > documentation.
>> > >
>> > > And for updating the release guide, I propose the following changes:
>> > >
>> > > 1. Add a new subsection to "Finalize the release", prior to
>> "Checklist to
>> > > proceed to the next step" with the following content:
>> > >
>> > > Publish the Dockerfiles for the new release
>> > > >
>> > > > Note: the official Dockerfiles fetch the binary distribution of the
>> > > target
>> > > > Flink version from an Apache mirror. After publishing the binary
>> > release
>> > > > artifacts, mirrors can take some hours to start serving the new
>> > > artifacts,
>> > > > so you may want to wait to do this step until you are ready to
>> continue
>> > > > with the "Promote the release" steps below.
>> > > >
>> > > > Follow the instructions in the [flink-docker] repo to build the new
>> > > > Dockerfiles and send an updated manifest to Docker Hub so the new
>> > images
>> > > > are built and published.
>> > > >
>> > >
>> > > 2. Add an entry to the "Checklist to proceed to the next step"
>> subsection
>> > > of "Finalize the release":
>> > >
>> > > >
>> > > >    - Dockerfiles in flink-docker updated for the new Flink release
>> and
>> > > >    pull request opened on the Docker official-images with an updated
>> > > manifest
>> > > >
>> > > > Please let me know if you have any questions or suggestions to
>> improve
>> > > this proposal.
>> > >
>> > > Thanks,
>> > > Patrick
>> > >
>> > > [1]https://issues.apache.org/jira/browse/FLINK-15831
>> > > [2]https://github.com/apache/flink-docker
>> > > [3]https://github.com/apache/flink-docker/pull/5
>> > >
>> >
>>
>

[Chesnay Schepler-3]

@Patrick You should have the required wiki permissions now.

On 10/02/2020 12:12, Patrick Lucas wrote:

> Thanks for the feedback.
>
> Could someone (Ufuk or Till?) grant me access to to the FLINK space
> Confluence so I can make these changes? My Confluence username is plucas.
>
> Thanks,
> Patrick
>
> On Mon, Feb 10, 2020 at 9:54 AM Ufuk Celebi <[hidden email]> wrote:
>
>> +1 to have the README as source of truth and link to the repository from
>> the Wiki page.
>>
>> – Ufuk
>>
>>
>> On Mon, Feb 10, 2020 at 3:48 AM Yang Wang <[hidden email]> wrote:
>>
>>> +1 to make flink-docker repository self-contained, including the document.
>>> And others refer
>>> to it.
>>>
>>>
>>> Best,
>>> Yang
>>>
>>> Till Rohrmann <[hidden email]> 于2020年2月9日周日 下午5:35写道：
>>>
>>>> Sounds good to me Patrick. +1 for these changes.
>>>>
>>>> Cheers,
>>>> Till
>>>>
>>>> On Fri, Feb 7, 2020 at 3:25 PM Patrick Lucas <[hidden email]>
>>>> wrote:
>>>>
>>>>> Hi all,
>>>>>
>>>>> For FLINK-15831[1], I think the way to start is for the flink-docker
>>>>> repo[2] itself to sufficiently document the workflow for publishing
>>> new
>>>>> Dockerfiles, and then update the Flink release guide in the wiki to
>>> refer
>>>>> to this documentation and to include this step in the "Finalize the
>>>>> release" checklist.
>>>>>
>>>>> To the first point, I have opened a PR[3] on flink-docker to improve
>>> its
>>>>> documentation.
>>>>>
>>>>> And for updating the release guide, I propose the following changes:
>>>>>
>>>>> 1. Add a new subsection to "Finalize the release", prior to
>>> "Checklist to
>>>>> proceed to the next step" with the following content:
>>>>>
>>>>> Publish the Dockerfiles for the new release
>>>>>> Note: the official Dockerfiles fetch the binary distribution of the
>>>>> target
>>>>>> Flink version from an Apache mirror. After publishing the binary
>>>> release
>>>>>> artifacts, mirrors can take some hours to start serving the new
>>>>> artifacts,
>>>>>> so you may want to wait to do this step until you are ready to
>>> continue
>>>>>> with the "Promote the release" steps below.
>>>>>>
>>>>>> Follow the instructions in the [flink-docker] repo to build the new
>>>>>> Dockerfiles and send an updated manifest to Docker Hub so the new
>>>> images
>>>>>> are built and published.
>>>>>>
>>>>> 2. Add an entry to the "Checklist to proceed to the next step"
>>> subsection
>>>>> of "Finalize the release":
>>>>>
>>>>>>     - Dockerfiles in flink-docker updated for the new Flink release
>>> and
>>>>>>     pull request opened on the Docker official-images with an updated
>>>>> manifest
>>>>>> Please let me know if you have any questions or suggestions to
>>> improve
>>>>> this proposal.
>>>>>
>>>>> Thanks,
>>>>> Patrick
>>>>>
>>>>> [1]https://issues.apache.org/jira/browse/FLINK-15831
>>>>> [2]https://github.com/apache/flink-docker
>>>>> [3]https://github.com/apache/flink-docker/pull/5
>>>>>

[Patrick Lucas-2]

Thanks, Chesnay.

I've updated the release guide
<https://cwiki.apache.org/confluence/display/FLINK/Creating+a+Flink+Release>
with the new step.

--
Patrick

On Mon, Feb 10, 2020 at 12:34 PM Chesnay Schepler <[hidden email]>
wrote:

> @Patrick You should have the required wiki permissions now.
>
> On 10/02/2020 12:12, Patrick Lucas wrote:
> > Thanks for the feedback.
> >
> > Could someone (Ufuk or Till?) grant me access to to the FLINK space
> > Confluence so I can make these changes? My Confluence username is plucas.
> >
> > Thanks,
> > Patrick
> >
> > On Mon, Feb 10, 2020 at 9:54 AM Ufuk Celebi <[hidden email]> wrote:
> >
> >> +1 to have the README as source of truth and link to the repository from
> >> the Wiki page.
> >>
> >> – Ufuk
> >>
> >>
> >> On Mon, Feb 10, 2020 at 3:48 AM Yang Wang <[hidden email]>
> wrote:
> >>
> >>> +1 to make flink-docker repository self-contained, including the
> document.
> >>> And others refer
> >>> to it.
> >>>
> >>>
> >>> Best,
> >>> Yang
> >>>
> >>> Till Rohrmann <[hidden email]> 于2020年2月9日周日 下午5:35写道：
> >>>
> >>>> Sounds good to me Patrick. +1 for these changes.
> >>>>
> >>>> Cheers,
> >>>> Till
> >>>>
> >>>> On Fri, Feb 7, 2020 at 3:25 PM Patrick Lucas <[hidden email]>
> >>>> wrote:
> >>>>
> >>>>> Hi all,
> >>>>>
> >>>>> For FLINK-15831[1], I think the way to start is for the flink-docker
> >>>>> repo[2] itself to sufficiently document the workflow for publishing
> >>> new
> >>>>> Dockerfiles, and then update the Flink release guide in the wiki to
> >>> refer
> >>>>> to this documentation and to include this step in the "Finalize the
> >>>>> release" checklist.
> >>>>>
> >>>>> To the first point, I have opened a PR[3] on flink-docker to improve
> >>> its
> >>>>> documentation.
> >>>>>
> >>>>> And for updating the release guide, I propose the following changes:
> >>>>>
> >>>>> 1. Add a new subsection to "Finalize the release", prior to
> >>> "Checklist to
> >>>>> proceed to the next step" with the following content:
> >>>>>
> >>>>> Publish the Dockerfiles for the new release
> >>>>>> Note: the official Dockerfiles fetch the binary distribution of the
> >>>>> target
> >>>>>> Flink version from an Apache mirror. After publishing the binary
> >>>> release
> >>>>>> artifacts, mirrors can take some hours to start serving the new
> >>>>> artifacts,
> >>>>>> so you may want to wait to do this step until you are ready to
> >>> continue
> >>>>>> with the "Promote the release" steps below.
> >>>>>>
> >>>>>> Follow the instructions in the [flink-docker] repo to build the new
> >>>>>> Dockerfiles and send an updated manifest to Docker Hub so the new
> >>>> images
> >>>>>> are built and published.
> >>>>>>
> >>>>> 2. Add an entry to the "Checklist to proceed to the next step"
> >>> subsection
> >>>>> of "Finalize the release":
> >>>>>
> >>>>>>     - Dockerfiles in flink-docker updated for the new Flink release
> >>> and
> >>>>>>     pull request opened on the Docker official-images with an
> updated
> >>>>> manifest
> >>>>>> Please let me know if you have any questions or suggestions to
> >>> improve
> >>>>> this proposal.
> >>>>>
> >>>>> Thanks,
> >>>>> Patrick
> >>>>>
> >>>>> [1]https://issues.apache.org/jira/browse/FLINK-15831
> >>>>> [2]https://github.com/apache/flink-docker
> >>>>> [3]https://github.com/apache/flink-docker/pull/5
> >>>>>
>
>