From 2654679c56ff391f9608562e13b82b0a7a439fad Mon Sep 17 00:00:00 2001 From: AidanDelaney Date: Thu, 4 Apr 2024 15:44:26 +0000 Subject: [PATCH] Merge pull request #684 from buildpacks/fix/custom-env MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Fix summaries for "custom env" page and add link to podman from main … --- docs/app-journey/index.html | 5 +++-- .../special-cases/build-for-windows/index.html | 15 ++++++++------- .../special-cases/export-to-oci-layout/index.html | 4 ++-- .../how-to/special-cases/index.html | 15 ++++----------- .../how-to/special-cases/index.xml | 4 ++-- docs/index.xml | 2 +- index.xml | 6 +++--- 7 files changed, 23 insertions(+), 28 deletions(-) diff --git a/docs/app-journey/index.html b/docs/app-journey/index.html index b34ecd842..fb51d5999 100644 --- a/docs/app-journey/index.html +++ b/docs/app-journey/index.html @@ -874,9 +874,10 @@

An App’s Brief Journey from Source to Image

Pack for the journey

In this tutorial, we’ll explain how to use pack and buildpacks to create a runnable app image from source code.

-

In order to run the build process in an isolated fashion, pack uses Docker. That means you’ll need to make sure you have both docker and pack installed:

- Install Docker
+

In order to run the build process in an isolated fashion, pack uses Docker or a Docker-compatible daemon to create the containers where buildpacks execute. +That means you’ll need to make sure you have both pack and a daemon installed:

Install pack
+

Install Docker
or alternatively, see this page about working with podman.

NOTE: pack is only one implementation of the Cloud Native Buildpacks Platform Specification. Additionally, not all Cloud Native Buildpacks Platforms require Docker.

diff --git a/docs/for-app-developers/how-to/special-cases/build-for-windows/index.html b/docs/for-app-developers/how-to/special-cases/build-for-windows/index.html index 8ae25b1f8..51fdcac5c 100644 --- a/docs/for-app-developers/how-to/special-cases/build-for-windows/index.html +++ b/docs/for-app-developers/how-to/special-cases/build-for-windows/index.html @@ -8,9 +8,8 @@ - + @@ -24,9 +23,8 @@ - + @@ -874,7 +872,10 @@

Build for Windows containers

-
+

You can use buildpacks to build container images that run Windows containers on Windows (WCOW).

+

This page is not relevant if your host machine is Windows but you are running Linux containers on Windows (LCOW); +in this case, no special configuration is required.

+

EXPERIMENTAL Windows support is experimental!

Enable experimental mode by running: pack config experimental true

diff --git a/docs/for-app-developers/how-to/special-cases/export-to-oci-layout/index.html b/docs/for-app-developers/how-to/special-cases/export-to-oci-layout/index.html index fa61fefac..b6adb8c25 100644 --- a/docs/for-app-developers/how-to/special-cases/export-to-oci-layout/index.html +++ b/docs/for-app-developers/how-to/special-cases/export-to-oci-layout/index.html @@ -8,7 +8,7 @@ - + @@ -22,7 +22,7 @@ - + diff --git a/docs/for-app-developers/how-to/special-cases/index.html b/docs/for-app-developers/how-to/special-cases/index.html index 68242ed55..699b407c9 100644 --- a/docs/for-app-developers/how-to/special-cases/index.html +++ b/docs/for-app-developers/how-to/special-cases/index.html @@ -889,11 +889,9 @@

Build for Windows containers

-

EXPERIMENTAL Windows support is experimental! -Enable experimental mode by running: pack config experimental true -Before You Start Recommended reading Before trying out builds for Windows images, we recommend following the Linux image tutorial under Getting Started. Don’t worry, you can still run it on a Windows OS if you need to – just make sure to enable Linux containers for Docker first. -When you’re done, head back here. -Enable Windows container mode In order to produce Windows container images, ensure Windows container mode is enabled in your Docker settings (available only in Docker for Windows).

+

You can use buildpacks to build container images that run Windows containers on Windows (WCOW).

+

This page is not relevant if your host machine is Windows but you are running Linux containers on Windows (LCOW); +in this case, no special configuration is required.

@@ -901,12 +899,7 @@

Export to OCI layout format on disk

-

The OCI Image Layout is the directory structure for OCI content-addressable blobs and location-addressable references. See the specification. Exporting to OCI layout format is an experimental feature available on pack since version 0.30.0

-
    -
  1. Enable experimental feature Verify your pack version is equal or greater than 0.30.0 -pack version Enable the experimental features on pack -pack config experimental true You can confirm everything is fine, checking the config.toml file in your PACK_HOME installation folder.
    2. -

+

The OCI Image Layout is the directory structure for OCI content-addressable blobs and location-addressable references.

diff --git a/docs/for-app-developers/how-to/special-cases/index.xml b/docs/for-app-developers/how-to/special-cases/index.xml index 73ece67cf..ea816f332 100644 --- a/docs/for-app-developers/how-to/special-cases/index.xml +++ b/docs/for-app-developers/how-to/special-cases/index.xml @@ -19,14 +19,14 @@ https://buildpacks.io/docs/for-app-developers/how-to/special-cases/build-for-windows/ Mon, 01 Jan 0001 00:00:00 +0000 https://buildpacks.io/docs/for-app-developers/how-to/special-cases/build-for-windows/ - EXPERIMENTAL Windows support is experimental! Enable experimental mode by running: pack config experimental true Before You Start Recommended reading Before trying out builds for Windows images, we recommend following the Linux image tutorial under Getting Started. Don&rsquo;t worry, you can still run it on a Windows OS if you need to &ndash; just make sure to enable Linux containers for Docker first. When you&rsquo;re done, head back here. Enable Windows container mode In order to produce Windows container images, ensure Windows container mode is enabled in your Docker settings (available only in Docker for Windows). + <p>You can use buildpacks to build container images that run Windows containers on Windows (WCOW).</p> <p>This page is not relevant if your host machine is Windows but you are running Linux containers on Windows (LCOW); in this case, no special configuration is required.</p> Export to OCI layout format on disk https://buildpacks.io/docs/for-app-developers/how-to/special-cases/export-to-oci-layout/ Mon, 01 Jan 0001 00:00:00 +0000 https://buildpacks.io/docs/for-app-developers/how-to/special-cases/export-to-oci-layout/ - The OCI Image Layout is the directory structure for OCI content-addressable blobs and location-addressable references. See the specification. Exporting to OCI layout format is an experimental feature available on pack since version 0.30.0 1. Enable experimental feature Verify your pack version is equal or greater than 0.30.0 pack version Enable the experimental features on pack pack config experimental true You can confirm everything is fine, checking the config.toml file in your PACK_HOME installation folder. + The OCI Image Layout is the directory structure for OCI content-addressable blobs and location-addressable references. Use an HTTP proxy diff --git a/docs/index.xml b/docs/index.xml index 3459b493c..d6a8ce7c5 100644 --- a/docs/index.xml +++ b/docs/index.xml @@ -12,7 +12,7 @@ https://buildpacks.io/docs/app-journey/ Mon, 01 Jan 0001 00:00:00 +0000 https://buildpacks.io/docs/app-journey/ - Pack for the journey In this tutorial, we&rsquo;ll explain how to use pack and buildpacks to create a runnable app image from source code. In order to run the build process in an isolated fashion, pack uses Docker. That means you&rsquo;ll need to make sure you have both docker and pack installed: Install Docker Install pack NOTE: pack is only one implementation of the Cloud Native Buildpacks Platform Specification. Additionally, not all Cloud Native Buildpacks Platforms require Docker. + Pack for the journey In this tutorial, we&rsquo;ll explain how to use pack and buildpacks to create a runnable app image from source code. In order to run the build process in an isolated fashion, pack uses Docker or a Docker-compatible daemon to create the containers where buildpacks execute. That means you&rsquo;ll need to make sure you have both pack and a daemon installed: Install pack Install Docker or alternatively, see this page about working with podman. diff --git a/index.xml b/index.xml index bd1f55fd5..4bbd4b7f5 100644 --- a/index.xml +++ b/index.xml @@ -145,14 +145,14 @@ https://buildpacks.io/docs/app-journey/ Mon, 01 Jan 0001 00:00:00 +0000 https://buildpacks.io/docs/app-journey/ - Pack for the journey In this tutorial, we&rsquo;ll explain how to use pack and buildpacks to create a runnable app image from source code. In order to run the build process in an isolated fashion, pack uses Docker. That means you&rsquo;ll need to make sure you have both docker and pack installed: Install Docker Install pack NOTE: pack is only one implementation of the Cloud Native Buildpacks Platform Specification. Additionally, not all Cloud Native Buildpacks Platforms require Docker. + Pack for the journey In this tutorial, we&rsquo;ll explain how to use pack and buildpacks to create a runnable app image from source code. In order to run the build process in an isolated fashion, pack uses Docker or a Docker-compatible daemon to create the containers where buildpacks execute. That means you&rsquo;ll need to make sure you have both pack and a daemon installed: Install pack Install Docker or alternatively, see this page about working with podman. Build for Windows containers https://buildpacks.io/docs/for-app-developers/how-to/special-cases/build-for-windows/ Mon, 01 Jan 0001 00:00:00 +0000 https://buildpacks.io/docs/for-app-developers/how-to/special-cases/build-for-windows/ - EXPERIMENTAL Windows support is experimental! Enable experimental mode by running: pack config experimental true Before You Start Recommended reading Before trying out builds for Windows images, we recommend following the Linux image tutorial under Getting Started. Don&rsquo;t worry, you can still run it on a Windows OS if you need to &ndash; just make sure to enable Linux containers for Docker first. When you&rsquo;re done, head back here. Enable Windows container mode In order to produce Windows container images, ensure Windows container mode is enabled in your Docker settings (available only in Docker for Windows). + <p>You can use buildpacks to build container images that run Windows containers on Windows (WCOW).</p> <p>This page is not relevant if your host machine is Windows but you are running Linux containers on Windows (LCOW); in this case, no special configuration is required.</p> builder.toml @@ -327,7 +327,7 @@ https://buildpacks.io/docs/for-app-developers/how-to/special-cases/export-to-oci-layout/ Mon, 01 Jan 0001 00:00:00 +0000 https://buildpacks.io/docs/for-app-developers/how-to/special-cases/export-to-oci-layout/ - The OCI Image Layout is the directory structure for OCI content-addressable blobs and location-addressable references. See the specification. Exporting to OCI layout format is an experimental feature available on pack since version 0.30.0 1. Enable experimental feature Verify your pack version is equal or greater than 0.30.0 pack version Enable the experimental features on pack pack config experimental true You can confirm everything is fine, checking the config.toml file in your PACK_HOME installation folder. + The OCI Image Layout is the directory structure for OCI content-addressable blobs and location-addressable references. Mount volumes at build-time