![\"The](\"https:\/\/developers.redhat.com\/sites\/default\/files\/styles\/article_full_width_1440px_w\/public\/image_1.png?itok=AxLHdHot\")
<\/a>\n<\/div>\nContinue your automation journey with Ansible Automation Platform<\/h2>\n
Get started with Ansible Automation Platform<\/a>\u00a0by exploring interactive labs<\/a>. Check out Red Hat\u2019s hands-on labs for all skill levels to learn more. The\u00a0wide range of labs include\u00a0useful Linux commands<\/a>, Install software using package managers<\/a>, and Deploying containers using container tools [podman]<\/a>. Try these labs to see your favorite products in action.\u00a0Ansible Automation Platform is also available as a managed offering on Microsoft Azure<\/a> and as a self-managed offering on AWS<\/a>.<\/p>\n rh-ee-tpaul<\/span><\/span> How to create execution environments using ansible-builder<\/span><\/p>\n The execution environment builder (aka Ansible Builder) is a part of Red Hat Ansible Automation Platform<\/a>. It is a command-line interface (CLI) tool for building and creating custom execution environments. The Ansible Builder project enables users to automate and accelerate the process of creating execution environments. This article will show you how to install and use the execution environment builder<\/a> CLI tool.<\/p>\n The execution environment builder makes it easier for Ansible Automation Platform content creators and administrators to build custom execution environments. They can use dependency information from various Ansible Content Collections<\/a>\u00a0and directly from the user.<\/p>\n Install the execution environment builder tool from the Python Package Index (PyPI) by using the following command:<\/p>\n To access the subcommands of The It populates the build context and then uses Podman or Docker to create the execution environment image. The help output appears as follows:<\/p>\n The However, it will not build the execution environment image as you will see in the following output:<\/p>\n Populate the Populate the Create a Through the spec and requirements file, we ensure that execution environment builder will download the servicenow.itsm collection<\/strong> while building the execution environment. The default download location is galaxy.ansible.com<\/strong>. You can also point to an automation hub or your own hub instance in the spec file.<\/p>\n Build the execution environment using the previously created files. Run the following command to create a new custom execution environment called custom-ee:<\/strong><\/p>\n The The output appears as follows:<\/p>\n Run the following commands to check the image list:<\/p>\n The output appears as follows:<\/p>\n To build a complex execution environment, go back into the project directory with the following command:<\/p>\n Edit the We can see the following:<\/p>\n Now create a new file called We added a new collection called ansible.utils<\/strong> alongside the servicenow.itsm<\/strong> file.<\/p>\n Create a new file called This contains the Python<\/a> requirements that need to be installed via pip.<\/p>\n Create a new file called This file contains the rpm requirements needed to be installed using dnf.<\/p>\n Run the following build:<\/p>\n The output is as follows:<\/p>\n You can check the context or Log in to the private automation hub<\/a> by using the Then tag the image before pushing it to the hub as follows:<\/p>\n Finally, push it to the private automation hub as follows:<\/p>\n We can see the image pushed to the private automation hub in Figure 1:<\/p>\n Get started with Ansible Automation Platform<\/a>\u00a0by exploring interactive labs<\/a>. Check out Red Hat\u2019s hands-on labs for all skill levels to learn more. The\u00a0wide range of labs include\u00a0useful Linux commands<\/a>, Install software using package managers<\/a>, and Deploying containers using container tools [podman]<\/a>. Try these labs to see your favorite products in action.\u00a0Ansible Automation Platform is also available as a managed offering on Microsoft Azure<\/a> and as a self-managed offering on AWS<\/a>.<\/p>\n
\nMon, 05\/08\/2023 – 07:00<\/span>
\nTathagata Paul<\/a><\/p>\n\n![\\\"IT\u96fb\u8166\u88dc\u7fd2](\\\"http:\/\/itteacheritfreelance.hk\/test\/wordpress\/wp-content\/uploads\/2016\/05\/logo2-2.png\\\"){kind=logo}
\r\nwww.itsec.hk<\/a>
\r\nwww.itsec.vip<\/a>
\r\nwww.itseceu.uk<\/a>
<\/p>","protected":false},"excerpt":{"rendered":"Installing the execution environment builder<\/h2>\n
Step 1: Install the execution environment builder tool<\/h3>\n
\n
pip install ansible-builder<\/code><\/pre>\nStep 2: Access the ansible-builder subcommands<\/h3>\n
ansible-builder<\/code>, run build<\/code> and create<\/code> commands to get help output.<\/p>\nbuild<\/code> subcommand will build the execution environment using the definition file.<\/p>\n\n
ansible-builder build \u2013help<\/code><\/pre>\n\n
usage: ansible-builder build [-h] [-t TAG] [--container-runtime {podman,docker}] [--build-arg BUILD_ARGS] [-f FILENAME] [-c BUILD_CONTEXT]\n [--output-filename {Containerfile,Dockerfile}] [-v {0,1,2,3}]\n\nCreates a build context (including a Containerfile) from an execution environment spec. The build context will be populated from the execution environment spec. After that, the specified container runtime podman\/docker will be invoked to build an image from that definition. After building the image, it can be used locally or published using the\nsupplied tag.\n\noptional arguments:\n -h, --help show this help message and exit\n -t TAG, --tag TAG The name for the container image being built (default: ansible-execution-env:latest)\n --container-runtime {podman,docker}\n Specifies which container runtime to use (default: podman)\n --build-arg BUILD_ARGS\n Build-time variables to pass to any podman or docker calls. Internally ansible-builder makes use of ANSIBLE_GALAXY_CLI_COLLECTION_OPTS, EE_BASE_IMAGE,\n EE_BUILDER_IMAGE.\n -f FILENAME, --file FILENAME\n The definition of the execution environment (default: execution-environment.yml)\n -c BUILD_CONTEXT, --context BUILD_CONTEXT\n The directory to use for the build context (default: context)\n --output-filename {Containerfile,Dockerfile}\n Name of file to write image definition to (default depends on --container-runtime, Containerfile for podman and Dockerfile for docker)\n -v {0,1,2,3}, --verbosity {0,1,2,3}\n Increase the output verbosity, for up to three levels of verbosity (invoked via \"--verbosity\" or \"-v\" followed by an integer ranging in value from 0 to\n 3) (default: 2)\n<\/code><\/pre>\ncreate<\/code> subcommand works similar to the build<\/code> command.<\/p>\n\n
ansible-builder create \u2013help<\/code><\/pre>\n\n
usage: ansible-builder build [-h] [-t TAG] [--container-runtime {podman,docker}] [--build-arg BUILD_ARGS] [-f FILENAME] [-c BUILD_CONTEXT]\n [--output-filename {Containerfile,Dockerfile}] [-v {0,1,2,3}]\n\nCreates a build context (including a Containerfile) from an execution environment spec. The build context will be populated from the execution environment spec. After that,\nthe specified container runtime podman\/docker will be invoked to build an image from that definition. After building the image, it can be used locally or published using the\nsupplied tag.\n\noptional arguments:\n -h, --help show this help message and exit\n -t TAG, --tag TAG The name for the container image being built (default: ansible-execution-env:latest)\n --container-runtime {podman,docker}\n Specifies which container runtime to use (default: podman)\n --build-arg BUILD_ARGS\n Build-time variables to pass to any podman or docker calls. Internally ansible-builder makes use of ANSIBLE_GALAXY_CLI_COLLECTION_OPTS, EE_BASE_IMAGE,\n EE_BUILDER_IMAGE.\n -f FILENAME, --file FILENAME\n The definition of the execution environment (default: execution-environment.yml)\n -c BUILD_CONTEXT, --context BUILD_CONTEXT\n The directory to use for the build context (default: context)\n --output-filename {Containerfile,Dockerfile}\n Name of file to write image definition to (default depends on --container-runtime, Containerfile for podman and Dockerfile for docker)\n -v {0,1,2,3}, --verbosity {0,1,2,3}\n Increase the output verbosity, for up to three levels of verbosity (invoked via \"--verbosity\" or \"-v\" followed by an integer ranging in value from 0 to\n 3) (default: 2)\n<\/code><\/pre>\nStep 3: Populate the ansible-builder spec<\/h3>\n
ansible-builder<\/code> spec to build the custom execution environment by running the following command:<\/p>\n\n
mkdir project_directory && cd project_directory<\/code><\/pre>\nexecution-environment.yml<\/code> file:<\/p>\n\n
cat > execution-environment.yml\n---\nversion: 1\ndependencies:\n galaxy: requirements.yml\nEOT\n\n<\/code><\/pre>\nrequirements.yml<\/code> file and populate the contents with the following:<\/p>\n\n
cat > requirements.yml\n---\ncollections:\n - name: servicenow.itsm\nEOT<\/code><\/pre>\nStep 4: Build the execution environment<\/h3>\n
\n
ansible-builder build -v3 -t custom-ee<\/code><\/pre>\n-v3<\/code> flag adds verbosity to the CLI run, and\u00a0-t custom-ee<\/code> will tag your image with the name you provided.<\/p>\n\n
Ansible Builder is building your execution environment image, \"custom-ee\".\nFile context\/_build\/requirements.yml will be created.\nRewriting Containerfile to capture collection requirements\nRunning command:\n podman build -f context\/Containerfile -t custom-ee context\n[1\/3] STEP 1\/7: FROM registry.redhat.io\/ansible-automation-platform-21\/ee-minimal-rhel8:latest AS galaxy\n[1\/3] STEP 2\/7: ARG ANSIBLE_GALAXY_CLI_COLLECTION_OPTS=\n--> 88d9ea223d0\n[1\/3] STEP 3\/7: USER root\n--> 549f29055c2\n[1\/3] STEP 4\/7: ADD _build \/build\n--> 0d3e9515b12\n[1\/3] STEP 5\/7: WORKDIR \/build\n--> 3b290acf78c\n[1\/3] STEP 6\/7: RUN ansible-galaxy role install -r requirements.yml --roles-path \/usr\/share\/ansible\/roles\nSkipping install, no requirements found\n--> 8af36370e78\n[1\/3] STEP 7\/7: RUN ansible-galaxy collection install $ANSIBLE_GALAXY_CLI_COLLECTION_OPTS -r requirements.yml --collections-path \/usr\/share\/ansible\/collections\nStarting galaxy collection install process\nProcess install dependency map\n\u2026\n\n<\/code><\/pre>\n\n
podman images<\/code><\/pre>\n\n
REPOSITORY TAG IMAGE ID CREATED SIZE\nlocalhost\/custom-ee latest bfe6c40bad52 21 seconds ago 626 MB\n<\/code><\/pre>\nStep 5: Build a complex execution environment<\/h3>\n
\n
cd project_directory<\/code><\/pre>\nexecution-environment.yml<\/code> file and add the following content:<\/p>\n\n
cat > execution-environment.yml\n---\nversion: 1\ndependencies:\n galaxy: requirements.yml\n python: requirements.txt\n system: bindep.txt\nadditional_build_steps:\n prepend: |\n RUN whoami\n RUN cat \/etc\/os-release\n append:\n - RUN echo This is a post-install command!\n - RUN ls -la \/etc\nEOT<\/code><\/pre>\n\n
requirements.yml<\/code> and append the following content:<\/p>\n\n
cat > requirements.yml\n---\n\ncollections:\n\n - name: servicenow.itsm\n - name: ansible.utils\nEOT<\/code><\/pre>\nrequirements.txt<\/code> and then append the following:<\/p>\n\n
cat > requirements.txt\ngcp-cli\nncclient\nnetaddr\nparamiko\nEOT<\/code><\/pre>\nbindep.txt<\/code> and then append the following:<\/p>\n\n
cat > bindep.txt\nfindutils [compile platform:centos-8 platform:rhel-8]\ngcc [compile platform:centos-8 platform:rhel-8]\nmake [compile platform:centos-8 platform:rhel-8]\npython38-devel [compile platform:centos-8 platform:rhel-8]\npython38-cffi [platform:centos-8 platform:rhel-8]\npython38-cryptography [platform:centos-8 platform:rhel-8]\npython38-pycparser [platform:centos-8 platform:rhel-8]\nEOT<\/code><\/pre>\n\n
ansible-builder build -v3 -t custom-ee<\/code><\/pre>\n\n
Ansible Builder is building your execution environment image, \"custom-ee\".\nFile context\/_build\/requirements.yml will be created.\nFile context\/_build\/requirements.txt will be created.\nFile context\/_build\/bindep.txt will be created.\nRewriting Containerfile to capture collection requirements\nRunning command:\n podman build -f context\/Containerfile -t custom-ee context\n[1\/3] STEP 1\/7: FROM registry.redhat.io\/ansible-automation-platform-21\/ee-minimal-rhel8:latest AS galaxy\n[1\/3] STEP 2\/7: ARG ANSIBLE_GALAXY_CLI_COLLECTION_OPTS=\n--> Using cache 88d9ea223d01bec0d53eb7efcf0e76b5f7da0285a411f2ce0116fe9641cbc3a0\n--> 88d9ea223d0\n[1\/3] STEP 3\/7: USER root\n--> Using cache 549f29055c2f1ba0ef3f7c5dfdc67a40302ff0330af927adb94fbcd7b0b1e7b4\n--> 549f29055c2\n[1\/3] STEP 4\/7: ADD _build \/build\n--> 6b9ee91e773\n[1\/3] STEP 5\/7: WORKDIR \/build\n--> 5518e019f2d\n[1\/3] STEP 6\/7: RUN ansible-galaxy role install -r requirements.yml --roles-path \/usr\/share\/ansible\/roles\nSkipping install, no requirements found\n--> 60c1605d66c\n[1\/3] STEP 7\/7: RUN ansible-galaxy collection install $ANSIBLE_GALAXY_CLI_COLLECTION_OPTS -r requirements.yml --collections-path \/usr\/share\/ansible\/collections\nStarting galaxy collection install process\nProcess install dependency map<\/code><\/pre>\nContainerfile<\/code> to see all the steps you took to build the execution environment. You can transfer the context directory to a different server and replicate the image creation via docker<\/code> or podman<\/code> commands.<\/p>\nPushing the execution environment to a private automation hub<\/h2>\n
podman<\/code> command:<\/p>\n\n
podman login \n
podman tag localhost\/custom-ee \n
podman push <\/a>\n<\/div>\nContinue your automation journey with Ansible Automation Platform<\/h2>\n