Documentation for running AWX from the devel branch

[apollo13]

As requested by @thedoubl3j:

I am trying to run and test the current devel version of ansible to provide early feedback about the rewrite. So far I got the following:

• Ran make docker-compose and managed to open AWX on localhost:8013, which told me:

Oops... Looks like the UI wasn't properly built

• I then ran make ui/src/build which cloned https://github.com/ansible/ansible-ui.git and tried to build that. That fails for me with:

=== Installing webpack ===
Error: Need Node 18.x; found v22.19.0
make: *** [awx/ui/Makefile:90: awx/ui/src/node_modules/webpack] Error 1

So far so good, but ansible-ui has it's last change from September 2024 -- and Node 18 is EOL since months. Am I cloning the correct UI here and shouldn't the compose task have a dependency on that? Is there a way to build the ui in a container so I don't have to bother with node 18 on my system?

[craph]

I'm interrested too

[MalfuncEddie]

Also following

[thedoubl3j]

@apollo13 thanks for opening this and bringing over the context from the previous issue, my apologies for not updating this faster. an update on why I asked: we have some folks from the community team (including some engineers myself and other API engineers from controller) who are gonna look at doing some updates around docs development.

for now, I know I am asking for more here so I will tag the others, @craph @MalfuncEddie if any of you have time, go through our existing docs/makefile and just...try to get the dev container running. any errors you hit, pit falls, anything, document them here. anything that you might resolve yourself as well, document here and what you did (what you tried etc). specifically from this repo.

We (AWX/Controller team/community team) no longer own any part of the UI so those issues might be a bit harder for us to understand/triage but please still document them. please be as specific as possible and over share (obviously please cleanse any personal data etc as needed).

task for me: blow away my existing dev env and build dev container from scratch using existing docs then document.

cc @gundalow @oraNod

[mcen1]

I presume that offer is open to anybody aside from those tagged. I set about trying to build a container locally. I looked at https://github.com/ansible/awx/blob/devel/docs/build_awx_image.md so I ran make awx-kube-build. I ran in to two issues...

First one is SSH_AUTH_SOCK not being set. https://github.com/ansible/awx/blob/devel/Makefile#L629 and several other places contain this. What is the purpose of it? What host is it trying to connect to via SSH and for what purpose?

I edited my local Makefile and eliminated the --ssh flags and it got much farther into the build before erroring out at this:

=> [builder 13/15] COPY --from=ui-builder /tmp/src/awx/ui/build /tmp/src/awx/ui/build                                                                                                                      1.7s
=> ERROR [builder 14/15] RUN make sdist && /var/lib/awx/venv/awx/bin/pip install dist/awx.tar.gz                                                                                                           2.7s
------
> [builder 14/15] RUN make sdist && /var/lib/awx/venv/awx/bin/pip install dist/awx.tar.gz:
0.410 python3.11 -m build -s
0.504 * Creating isolated environment: venv+pip...
0.510 * Installing packages in isolated environment:
2.314   - setuptools>=45
2.314   - setuptools_scm[toml]>=6.2
2.314 * Getting build dependencies for sdist...
2.531 /tmp/build-env-d03lsmtz/lib64/python3.11/site-packages/setuptools_scm/_integration/deprecation.py:7: UserWarning: setup.cfg: at [metadata]
2.531 version = attr: ... is forcing setuptools to override the version setuptools-scm did already set
2.531 When using setuptools-scm it's invalid to use setuptools dynamic version as well, please remove it.
2.531 Setuptools-scm is responsible for setting the version, forcing setuptools to override creates errors.
2.531   warnings.warn(
2.532 toml section missing PosixPath('pyproject.toml') does not contain a tool.setuptools_scm section
2.536 Traceback (most recent call last):
2.536   File "/usr/local/lib/python3.11/site-packages/pyproject_hooks/_in_process/_in_process.py", line 389, in <module>
2.536     main()
2.536   File "/usr/local/lib/python3.11/site-packages/pyproject_hooks/_in_process/_in_process.py", line 373, in main
2.536     json_out["return_val"] = hook(**hook_input["kwargs"])
2.536                              ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2.536   File "/usr/local/lib/python3.11/site-packages/pyproject_hooks/_in_process/_in_process.py", line 317, in get_requires_for_build_sdist
2.536     return hook(config_settings)
2.536            ^^^^^^^^^^^^^^^^^^^^^
2.536   File "/tmp/build-env-d03lsmtz/lib64/python3.11/site-packages/setuptools/build_meta.py", line 334, in get_requires_for_build_sdist
2.536     return self._get_build_requires(config_settings, requirements=[])
2.536            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2.536   File "/tmp/build-env-d03lsmtz/lib64/python3.11/site-packages/setuptools/build_meta.py", line 301, in _get_build_requires
2.537     self.run_setup()
2.537   File "/tmp/build-env-d03lsmtz/lib64/python3.11/site-packages/setuptools/build_meta.py", line 317, in run_setup
2.537     exec(code, locals())
2.537   File "<string>", line 1, in <module>
2.537   File "/tmp/build-env-d03lsmtz/lib64/python3.11/site-packages/setuptools/__init__.py", line 115, in setup
2.537     return distutils.core.setup(**attrs)
2.537            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2.537   File "/tmp/build-env-d03lsmtz/lib64/python3.11/site-packages/setuptools/_distutils/core.py", line 160, in setup
2.537     dist.parse_config_files()
2.537   File "/tmp/build-env-d03lsmtz/lib64/python3.11/site-packages/setuptools/dist.py", line 752, in parse_config_files
2.537     setupcfg.parse_configuration(
2.537   File "/tmp/build-env-d03lsmtz/lib64/python3.11/site-packages/setuptools/config/setupcfg.py", line 188, in parse_configuration
2.537     meta.parse()
2.537   File "/tmp/build-env-d03lsmtz/lib64/python3.11/site-packages/setuptools/config/setupcfg.py", line 502, in parse
2.537     section_parser_method(section_options)
2.537   File "/tmp/build-env-d03lsmtz/lib64/python3.11/site-packages/setuptools/config/setupcfg.py", line 477, in parse_section
2.537     self[name] = value
2.537     ~~~~^^^^^^
2.537   File "/tmp/build-env-d03lsmtz/lib64/python3.11/site-packages/setuptools/config/setupcfg.py", line 294, in __setitem__
2.537     parsed = self.parsers.get(option_name, lambda x: x)(value)
2.537              ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2.537   File "/tmp/build-env-d03lsmtz/lib64/python3.11/site-packages/setuptools/config/setupcfg.py", line 600, in _parse_version
2.537     return expand.version(self._parse_attr(value, self.package_dir, self.root_dir))
2.537            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2.537   File "/tmp/build-env-d03lsmtz/lib64/python3.11/site-packages/setuptools/config/expand.py", line 329, in version
2.538     _value = value() if callable(value) else value
2.538              ^^^^^^^
2.538   File "/tmp/src/awx/__init__.py", line 18, in get_version
2.538     version = get_version(root='..', relative_to=__file__)
2.538               ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2.538   File "/tmp/build-env-d03lsmtz/lib64/python3.11/site-packages/setuptools_scm/_get_version_impl.py", line 238, in get_version
2.538     _version_missing(config)
2.538   File "/tmp/build-env-d03lsmtz/lib64/python3.11/site-packages/setuptools_scm/_get_version_impl.py", line 188, in _version_missing
2.538     raise LookupError(error_msg)
2.538 LookupError: setuptools-scm was unable to detect version for /tmp/src.
2.538
2.538 Make sure you're either building from a fully intact git repository or PyPI tarballs. Most other sources (such as GitHub's tarballs, a git checkout without the .git folder) don't contain the necessary metadata and will not work.
2.538
2.538 For example, if you're using pip, instead of https://github.com/user/proj/archive/master.zip use git+https://github.com/user/proj.git#egg=proj
2.538
2.538 Alternatively, set the version with the environment variable SETUPTOOLS_SCM_PRETEND_VERSION_FOR_${NORMALIZED_DIST_NAME} as described in https://setuptools-scm.readthedocs.io/en/latest/config/
2.571
2.571 ERROR Backend subprocess exited when trying to invoke get_requires_for_build_sdist
2.582 make: *** [Makefile:465: dist/awx-.tar.gz] Error

[thedoubl3j]

@mcen1 absolutely open for anyone. at some point I might transition this to the forum since github issues...is kinda like...usually specific to one thing and while this is very much one thing...that thing is fairly large.

looking into ssh_auth_sock now and trying to get context.

[sarahwinters-UTD]

If you run the command eval "$(ssh-agent -s)" before running make, it clears the SSH_AUTH_SOCK error. However, I run into a JavaScript heap out of memory error in the make UI step of the build

[mcen1]

Thanks, that eval got around it. It's interesting you're hitting a Javascript heap error, I don't get that far. My issue with the setup.cfg persists. Also, looking at https://github.com/ansible/ansible-ui/tree/main this is the project being referenced, right? "main" hasn't been updated in a year at all. Shouldn't there be dependencies and vulnerabilities being updated, at least? Has anyone got a build to work...?

[MalfuncEddie]

https://github.com/ansible/awx/tree/devel/tools/docker-compose

using this:
ERROR: failed to build: failed to convert agent config {default [] false}: invalid empty ssh agent socket: make sure SSH_AUTH_SOCK is set
solved by @sarahwinters-UTD

If you run the command eval "$(ssh-agent -s)" before running make, it clears the SSH_AUTH_SOCK error. However, I run into a JavaScript heap out of memory error in the make UI step of the build

make docker-compose-build
I noticed it does not use tools/docker-compose/inventory db settings that I set in tools/docker-compose/inventory (or at least it does create an pg container even if those things are set. But for testing the build I just went with the standard pg container

make docker-compose

-> Oops... Looks like the UI wasn't properly built

make clean/ui ui

lots of deprecated errors and vulnerabilities (but let's ignore this)
run
make docker-compose

blank screen -> I do see title "AWX" but the body tag is empty
api site does work

--> in awx/awx/ui/src run

export AWX_SERVER=https://localhost:8043 export AWX_USERNAME='root' export AWX_PASSWORD='XXXX' npm run awx

got the gui

so Yeey

[ewaldmire]

Thanks, that eval got around it. It's interesting you're hitting a Javascript heap error, I don't get that far. My issue with the setup.cfg persists. Also, looking at https://github.com/ansible/ansible-ui/tree/main this is the project being referenced, right? "main" hasn't been updated in a year at all. Shouldn't there be dependencies and vulnerabilities being updated, at least? Has anyone got a build to work...?

I have a feeling https://github.com/ansible/ansible-hub-ui needs to be used instead.... somehow.

[mcen1]

I edited awx/ui/Makefile to reference ansible-hub-ui with "master" as the branch instead, and it fails with Missing script: "build:awx", I dunno if anything in this repo was tested by anyone in the past year.

[apollo13]

I have a feeling https://github.com/ansible/ansible-hub-ui needs to be used instead.... somehow.

Doubt it, that is for galaxy/hub afaik, not AWX

[MalfuncEddie]

I have a feeling https://github.com/ansible/ansible-hub-ui needs to be used instead.... somehow.

Doubt it, that is for galaxy/hub afaik, not AWX

Ansible-ui is the ui for awx. Awx used to have ot's own ui but that has been removed from the devel branch.

(Kind of sad since I liked that ui more since my Javascript is a bit lacking)

I've been doing some experiments with the new ui and clauded my way to something that I thinks works with nodejs 24. But I have yet to test the awx devel and ui branches in a more active environment.

Edit: @apollo13 @mcen1 you need this https://github.com/ansible/ansible-ui

[ziegenberg]

I got the UI running, but I am stuck at the login credentials. Where are they defined?