[ci:docs] Add man page for Containerfile and .containerignore #3549

rhatdan · 2021-09-28T14:47:29Z

Signed-off-by: Daniel J Walsh dwalsh@redhat.com

What type of PR is this?

/kind api-change
/kind bug
/kind cleanup
/kind deprecation
/kind design
/kind documentation
/kind failing-test
/kind feature
/kind flake
/kind other

What this PR does / why we need it:

How to verify it

Which issue(s) this PR fixes:

Special notes for your reviewer:

Does this PR introduce a user-facing change?

openshift-ci · 2021-09-28T14:47:31Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: rhatdan

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [rhatdan]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

TomSweeneyRedHat · 2021-09-28T15:32:51Z

docs/Containerfile.5.md

+  valid image. It is easy to start by pulling an image from the public
+  repositories.
+
+  -- **FROM** must be the first non-comment instruction in Containerfile.


Suggested change

-- **FROM** must be the first non-comment instruction in Containerfile.

-- **FROM** must be the first non-comment instruction in the Containerfile.

ARG is also permitted before the first FROM.

TomSweeneyRedHat · 2021-09-28T15:35:14Z

docs/Containerfile.5.md

+  `FROM image@digest`
+
+  -- The **FROM** instruction sets the base image for subsequent instructions. A
+  valid Containerfile must have **FROM** as its first instruction. The image can be any


Suggested change

valid Containerfile must have **FROM** as its first instruction. The image can be any

valid Containerfile must have **FROM** as its first instruction. The image can be any

An ARG can be the first line too...

Are you going to adjust this?

TomSweeneyRedHat · 2021-09-28T15:49:21Z

docs/Containerfile.5.md

+  difficult to update because it mixes with application-specific code.
+  The solution is to use **ONBUILD** to register instructions in advance, to
+  run later, during the next build stage.
+


Why are Arg and Onbuild not in alphanumeric order?

TomSweeneyRedHat · 2021-09-28T15:53:07Z

docs/Containerfile.5.md

+  ARG user1
+  ARG buildno
+  ...
+  ```


I just spotted a double lined comment here and other places. Are they correct?

This is intentional, I believe. This Containerfile is based off of the original Dockerfile man page.

TomSweeneyRedHat · 2021-09-28T17:27:56Z

docs/Containerfile.5.md

+
+  ```
+  $ podman build --build-arg HTTPS_PROXY=https://my-proxy.example.com .
+  ```


Unless I missed it, I didn't see a note that a second FROM in a Containerfile sets the values associated with an Arg variable to nil and they must be reset if they are to be used later in the Containerfile.

Added this note to ARGS section.

TomSweeneyRedHat · 2021-09-28T17:31:21Z

docs/Containerfile.5.md

+Feb 2015, updated by Brian Goff (cpuguy83@gmail.com) for readability
+Sept 2015, updated by Sally O'Malley (somalley@redhat.com)
+Oct 2016, updated by Addam Hardy (addam.hardy@gmail.com)
+Aug 2021, converted Dockerfile man page to Containerfile by Dan Walsh (dwalsh@redhat.com)


It might be nice to have a Containers/Containerfiles repo with well documented Containerfiles for commona containers (nginx, onbuild examples, etc.). Not for the PR, just something we might want to consider.

That should be in Buildah if it was there.

TomSweeneyRedHat · 2021-09-28T17:33:11Z

docs/containerignore.5.md

@@ -0,0 +1,87 @@
+% "containerignore" "28" "Sep 2021" "" "Container User Manuals"


IDK, but can we rename this to .containerignore or does that throw man pages for a loop?

I am not sure. Users are not going to type that though. I did setup a link to this from .containerignore

docs/containerignore.5.md

rhatdan · 2021-09-28T19:53:39Z

@edsantiago PTAL I need help on hack/xref-helpmsgs-manpages

edsantiago · 2021-09-28T20:05:27Z

foo.diff.txt

edsantiago · 2021-09-28T20:33:20Z

It's the add-a-test nagger: it doesn't have .gitignore in its exclusion list.

You can either add the magic no-new-tests string, or

diff --git a/tests/validate/pr-should-include-tests b/tests/validate/pr-should-include-tests
index 4cc843df..6d2a1835 100755
--- a/tests/validate/pr-should-include-tests
+++ b/tests/validate/pr-should-include-tests
@@ -45,6 +45,7 @@ fi
 filtered_changes=$(git diff --name-status $base $head |
                        awk '{print $2}'               |
                        fgrep -vx .cirrus.yml          |
+                       fgrep -vx .gitignore           |
                        fgrep -vx changelog.txt        |
                        fgrep -vx go.mod               |
                        fgrep -vx go.sum               |

docs/Containerfile.5.md

TomSweeneyRedHat · 2021-09-29T14:24:13Z

At least one small nit that needs changing and I think you need to rebase anyway. One other question.

Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>

ashley-cui · 2021-09-29T19:00:05Z

LGTM

TomSweeneyRedHat · 2021-09-29T19:26:12Z

LGTM
but will open an issue to correct the verbiage that FROM must be the first line in a Conatinerfile when ARG can be too.

TomSweeneyRedHat · 2021-09-29T19:26:20Z

/lgtm

openshift-ci bot added the approved label Sep 28, 2021

rhatdan force-pushed the containerfile branch 2 times, most recently from a322aaf to 00cae3a Compare September 28, 2021 14:57

rhatdan changed the title ~~Add man page for Containerfile and .containerignore~~ [ci:docs] Add man page for Containerfile and .containerignore Sep 28, 2021

rhatdan force-pushed the containerfile branch 2 times, most recently from 74c434f to d138c25 Compare September 28, 2021 15:00

TomSweeneyRedHat reviewed Sep 28, 2021

View reviewed changes

docs/containerignore.5.md Outdated Show resolved Hide resolved

rhatdan force-pushed the containerfile branch 3 times, most recently from 721c27b to 5f2d8eb Compare September 28, 2021 19:53

rhatdan force-pushed the containerfile branch from 5f2d8eb to 9722a52 Compare September 28, 2021 20:16

rhatdan force-pushed the containerfile branch from 9722a52 to 5bae6c9 Compare September 28, 2021 21:07

TomSweeneyRedHat reviewed Sep 29, 2021

View reviewed changes

docs/Containerfile.5.md Show resolved Hide resolved

Add man page for Containerfile and .containerignore

a9e66ec

Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>

rhatdan force-pushed the containerfile branch from ec3b666 to a9e66ec Compare September 29, 2021 15:20

openshift-ci bot assigned TomSweeneyRedHat Sep 29, 2021

openshift-ci bot added the lgtm label Sep 29, 2021

openshift-merge-robot merged commit d2ef199 into containers:main Sep 29, 2021

dilyanpalauzov mentioned this pull request Sep 30, 2021

bud: Do not assume implicit ENV PATH=… in Containerfile #3512

Closed

github-actions bot added the locked - please file new issue/PR label Sep 15, 2023

github-actions bot locked as resolved and limited conversation to collaborators Sep 15, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[ci:docs] Add man page for Containerfile and .containerignore #3549

[ci:docs] Add man page for Containerfile and .containerignore #3549

rhatdan commented Sep 28, 2021

openshift-ci bot commented Sep 28, 2021

TomSweeneyRedHat Sep 28, 2021

nalind Sep 28, 2021

TomSweeneyRedHat Sep 28, 2021

TomSweeneyRedHat Sep 29, 2021

TomSweeneyRedHat Sep 28, 2021

TomSweeneyRedHat Sep 28, 2021

rhatdan Sep 29, 2021

TomSweeneyRedHat Sep 28, 2021

rhatdan Sep 28, 2021

TomSweeneyRedHat Sep 28, 2021

rhatdan Sep 28, 2021

TomSweeneyRedHat Sep 28, 2021

rhatdan Sep 28, 2021 •

edited

rhatdan commented Sep 28, 2021

edsantiago commented Sep 28, 2021

edsantiago commented Sep 28, 2021

TomSweeneyRedHat commented Sep 29, 2021

ashley-cui commented Sep 29, 2021

TomSweeneyRedHat commented Sep 29, 2021

TomSweeneyRedHat commented Sep 29, 2021

	-- FROM must be the first non-comment instruction in Containerfile.
	-- FROM must be the first non-comment instruction in the Containerfile.

	valid Containerfile must have FROM as its first instruction. The image can be any
	valid Containerfile must have FROM as its first instruction. The image can be any

		@@ -0,0 +1,87 @@
		% "containerignore" "28" "Sep 2021" "" "Container User Manuals"

[ci:docs] Add man page for Containerfile and .containerignore #3549

[ci:docs] Add man page for Containerfile and .containerignore #3549

Conversation

rhatdan commented Sep 28, 2021

What type of PR is this?

What this PR does / why we need it:

How to verify it

Which issue(s) this PR fixes:

Special notes for your reviewer:

Does this PR introduce a user-facing change?

openshift-ci bot commented Sep 28, 2021

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

Choose a reason for hiding this comment

rhatdan Sep 28, 2021 • edited

Choose a reason for hiding this comment

rhatdan commented Sep 28, 2021

edsantiago commented Sep 28, 2021

edsantiago commented Sep 28, 2021

TomSweeneyRedHat commented Sep 29, 2021

ashley-cui commented Sep 29, 2021

TomSweeneyRedHat commented Sep 29, 2021

TomSweeneyRedHat commented Sep 29, 2021

rhatdan Sep 28, 2021 •

edited