Skip to content

Commit

Permalink
Adjusted documentation of full-control-dockerfile experimental flag
Browse files Browse the repository at this point in the history
Signed-off-by: Jens Arnfast <jens@arnfast.net>
  • Loading branch information
jarnfast committed May 14, 2024
1 parent 687eb8c commit 1e718dd
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 10 deletions.
8 changes: 4 additions & 4 deletions docs/content/docs/configuration/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -282,11 +282,11 @@ When it is completed, it is used to activate the features from [PEP003 - Advance
### Full control Dockerfile

The `full-control-dockerfile` experimental flag disables all Dockerfile generation when building bundles.
When enabled Porter will use the file referenced by `dockerfile` when building the invocation image without modifying it in any way.
This includes injection of any `# PORTER_x` templates, user configuration and `CMD` statements.
It is up to the bundle author to ensure that the file referenced by `dockerfile` contains the necessary tools for any mixins to function and a layout that can be executed as a Porter bundle.
When enabled Porter will use the file referenced by `dockerfile` in the Porter manifest when building the invocation image *without modifying* it in any way.
Ie. Porter will not process `# PORTER_x` placeholders, nor inject any user configuration and `CMD` statements.
It is up to the bundle author to ensure that the contents of the Dockerfile contains the necessary tools for any mixins to function and a layout that can be executed as a Porter bundle.

Note that `autobuild` does not detect changes to the contents of the file referenced by `dockerfile`.
*Note:* when using the `dockerfile` property in the Porter manifest the `autobuild` functionality does not re-build the bundle on changes to the contents of the referenced file.

## Common Configuration Settings

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -279,12 +279,11 @@ When it is completed, it is used to activate the features from [PEP003 - Advance
### Full control Dockerfile

The `full-control-dockerfile` experimental flag disables all Dockerfile generation when building bundles.
When enabled Porter will use the file referenced by `dockerfile` when building the invocation image without modifying it in any way.
This includes injection of any `# PORTER_x` templates, user configuration and `CMD` statements.
It is up to the bundle author to ensure that the file referenced by `dockerfile` contains the necessary tools for any mixins to function and a layout that can be executed as a Porter bundle.

Note that `autobuild` does not detect changes to the contents of the file referenced by `dockerfile`.
When enabled Porter will use the file referenced by `dockerfile` in the Porter manifest when building the invocation image *without modifying* it in any way.
Ie. Porter will not process `# PORTER_x` placeholders, nor inject any user configuration and `CMD` statements.
It is up to the bundle author to ensure that the contents of the Dockerfile contains the necessary tools for any mixins to function and a layout that can be executed as a Porter bundle.

*Note:* when using the `dockerfile` property in the Porter manifest the `autobuild` functionality does not re-build the bundle on changes to the contents of the referenced file.
## Common Configuration Settings

Some configuration settings are applicable to many of Porter's commands and to save time you may want to set these values in the configuration file or with environment variables.
Expand Down
2 changes: 1 addition & 1 deletion pkg/build/dockerfile-generator.go
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ func (g *DockerfileGenerator) GenerateDockerFile(ctx context.Context) error {
var lines []string
var err error
if g.Config.IsFeatureEnabled(experimental.FlagFullControlDockerfile) {
span.Warnf("Experimental feature \"%s\" enabled: Dockerfile will be used without changes by Porter",
span.Warnf("WARNING: Experimental feature \"%s\" enabled: Dockerfile will be used without changes by Porter",
experimental.FullControlDockerfile)
lines, err = g.readRawDockerfile(ctx)
if err != nil {
Expand Down

0 comments on commit 1e718dd

Please sign in to comment.