From b7ff6c72bf8bce7a6b032da7c6526a7c889c5975 Mon Sep 17 00:00:00 2001 From: Hamza Date: Sun, 20 Aug 2023 14:28:25 +0200 Subject: [PATCH 1/2] fix default definition file name typo --- docs/definition.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/definition.rst b/docs/definition.rst index 2099ced1..96e30ecc 100644 --- a/docs/definition.rst +++ b/docs/definition.rst @@ -3,7 +3,7 @@ Execution environment definition ================================ -You define the content of your execution environment in a YAML file. By default, this file is called ``execution_environment.yml``. This file tells Ansible Builder how to create the build instruction file (Containerfile for Podman, Dockerfile for Docker) and build context for your container image. +You define the content of your execution environment in a YAML file. By default, this file is called ``execution-environment.yml``. This file tells Ansible Builder how to create the build instruction file (Containerfile for Podman, Dockerfile for Docker) and build context for your container image. .. note:: This page documents the definition schema for Ansible Builder 3.x. If you are running an older version of Ansible Builder, you need an older schema version. Please consult older versions of the docs for more information. We recommend using version 3, which offers substantially more configurability and functionality than previous versions. From b2a57b2e729ee59d3f46aad82556d7da70db005f Mon Sep 17 00:00:00 2001 From: Abhijeet Kasurde Date: Mon, 25 Sep 2023 10:20:08 -0700 Subject: [PATCH 2/2] review comments Signed-off-by: Abhijeet Kasurde --- docs/definition.rst | 12 ++++++------ docs/index.rst | 6 +++--- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/definition.rst b/docs/definition.rst index 96e30ecc..a13b6276 100644 --- a/docs/definition.rst +++ b/docs/definition.rst @@ -3,7 +3,7 @@ Execution environment definition ================================ -You define the content of your execution environment in a YAML file. By default, this file is called ``execution-environment.yml``. This file tells Ansible Builder how to create the build instruction file (Containerfile for Podman, Dockerfile for Docker) and build context for your container image. +You define the content of your execution environment in a YAML file. By default, this file is called ``execution-environment.yml``. This file tells Ansible Builder how to create the build instruction file (``Containerfile`` for Podman, ``Dockerfile`` for Docker) and build context for your container image. .. note:: This page documents the definition schema for Ansible Builder 3.x. If you are running an older version of Ansible Builder, you need an older schema version. Please consult older versions of the docs for more information. We recommend using version 3, which offers substantially more configurability and functionality than previous versions. @@ -184,7 +184,7 @@ dependencies Specifies dependencies to install into the final image, including ``ansible-core``, ``ansible-runner``, Python packages, system packages, and Ansible Collections. Ansible Builder automatically installs dependencies for any Ansible Collections you install. -In general you can use standard syntax to constrain package versions. Use the same syntax you would pass to ``dnf``, ``pip``, ``ansible-galaxy``, or any other package management utility. You can also define your packages or collections in separate files and reference those files in the ``dependencies`` section of your execution environment definition file. +In general, you can use standard syntax to constrain package versions. Use the same syntax you would pass to ``dnf``, ``pip``, ``ansible-galaxy``, or any other package management utility. You can also define your packages or collections in separate files and reference those files in the ``dependencies`` section of your execution environment definition file. The following keys are valid for this section: @@ -230,7 +230,7 @@ The following keys are valid for this section: ``python_interpreter`` A dictionary that defines the Python system package name to be installed by - dnf (``package_system``) and/or a path to the Python interpreter to be used + ``dnf`` (``package_system``) and/or a path to the Python interpreter to be used (``python_path``). ``system`` @@ -292,7 +292,7 @@ Valid keys for this section are: image verification """""""""""""""""" You can verify signed container images if you are using the ``podman`` container -runtime. Set the :ref:`container-policy` CLI option to control how this data is used in relation to a Podman +runtime. Set the :ref:`container-policy` CLI option to control how this data is used with a Podman `policy.json `_ file for container image signature validation. @@ -320,7 +320,7 @@ builder runtime functionality. Valid keys for this section are: A dictionary with keys that allow for customization of the container ``ENTRYPOINT`` and ``CMD`` directives (and related behaviors). Customizing these behaviors is an advanced task, and may result in subtle, difficult-to-debug failures. As the provided defaults for - this section control a number of intertwined behaviors, overriding any value will skip all + this section control several intertwined behaviors, overriding any value will skip all remaining defaults in this dictionary. Valid keys are: @@ -373,7 +373,7 @@ builder runtime functionality. Valid keys for this section are: The default value ``1000``. ``tags`` - Specifies the name which is assigned to resulting image if build process completes successfully. + Specifies the names that are assigned to the resulting image if the build process completes successfully. The default value is ``ansible-execution-env:latest``. Example ``options`` section: diff --git a/docs/index.rst b/docs/index.rst index fb7d256a..f1624249 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -39,8 +39,8 @@ Quickstart for Ansible Builder To get started with Ansible Builder, you must install the ``ansible-builder`` utility and a containerization tool. Once you have the tools you need, create an :ref:`execution environment definition ` file. -By default this file is called ``execution_environment.yml``. -In the execution environment definition file you can specify the exact content you want to include in your +By default, this file is called ``execution-environment.yml``. +In the execution environment definition file, you can specify the exact content you want to include in your execution environment. You can specify these items: - the base container image @@ -83,7 +83,7 @@ The same four stages get executed if you build your container image directly wit 1. **Base**: uses Podman or Docker to pull the base image you defined, then installs the Python version (if defined and different from any Python on the base image), pip, ansible-runner, and ansible-core or ansible. All three later stages of the build process build on the output of the Base stage. 2. **Galaxy**: downloads the collections you defined from Galaxy and stashes them locally as files. -3. **Builder**: downloads the other packages (Python packages and system packages) you defined and stashes them locally as files. +3. **Builder**: downloads the other packages (Python packages and system packages) you defined and stash them locally as files. 4. **Final**: integrates the first three stages, installing all the stashed files on the output of the Base stage and generating a new image that includes all the content. Ansible Builder injects hooks at each stage of the container build process so you can add custom steps before and after every build stage.