Docs on how to add custom AWX logo

[fosterseth]

Please confirm the following

• I agree to follow this project's code of conduct.
• I have checked the current issues for duplicates.
• I understand that AWX Operator is open source software provided for free and that I might not receive a timely response.

Feature Summary

Users may wish to swap out the AWX logo for their own. It would be nice to have docs (and maybe an operator change) to allow for this.

See this PR on how to change awx logo for the older docker based deployments. This approach would be need to be updated to work with k8s deployments.

ansible/awx#12265

[fosterseth]

@shanemcd may have docs on this

[rebeccahhh]

relevant awx docs to model after(maybe?):
old: https://docs.ansible.com/ansible-tower/latest/html/administration/custom_rebranding.html
old: https://docs.ansible.com/ansible-tower/2.4.5/html/administration/custom_rebranding.html
latest: https://docs.ansible.com/automation-controller/latest/html/administration/custom_rebranding.html

[YaronL16]

I would like to contribute but am new to open-source and have never done so before, am I correct assuming the doc should go in '/docs/user-guide/advanced-configuration'?

[kurokobo]

@YaronL16
Hi, welcome to the community 😃
You are right, the new docs for this issue should be placed under /docs/user-guide/advanced-configuration.

The whole documentation is build by mkdocs, so in addition to place new markdown files there, adding navigation in mkdocs.yml is required:

awx-operator/mkdocs.yml

Lines 40 to 90 in f8bbe9f

	nav:
	- index.md
	- Contributors Guide:
	- contributors-guide/contributing.md
	- contributors-guide/release-process.md
	- contributors-guide/author.md
	- contributors-guide/code-of-conduct.md
	- contributors-guide/get-involved.md
	- Installation:
	- Installation: installation/index.md
	- installation/basic-install.md
	- installation/creating-a-minikube-cluster-for-testing.md
	- installation/helm-install-on-existing-cluster.md
	- Migrate:
	- migration/migration.md
	- Uninstall:
	- uninstall/uninstall.md
	- User Guide:
	- user-guide/admin-user-account-configuration.md
	- user-guide/network-and-tls-configuration.md
	- user-guide/database-configuration.md
	- Upgrade:
	- upgrade/upgrading.md
	- Advanced Configuration:
	- user-guide/advanced-configuration/deploying-a-specific-version-of-awx.md
	- user-guide/advanced-configuration/redis-container-capabilities.md
	- user-guide/advanced-configuration/privileged-tasks.md
	- user-guide/advanced-configuration/containers-resource-requirements.md
	- user-guide/advanced-configuration/priority-classes.md
	- user-guide/advanced-configuration/adding-execution-nodes.md
	- user-guide/advanced-configuration/scaling-the-web-and-task-pods-independently.md
	- user-guide/advanced-configuration/assigning-awx-pods-to-specific-nodes.md
	- user-guide/advanced-configuration/trusting-a-custom-certificate-authority.md
	- user-guide/advanced-configuration/custom-receptor-certs.md
	- user-guide/advanced-configuration/enabling-ldap-integration-at-awx-bootstrap.md
	- user-guide/advanced-configuration/persisting-projects-directory.md
	- user-guide/advanced-configuration/custom-volume-and-volume-mount-options.md
	- user-guide/advanced-configuration/default-execution-environments-from-private-registries.md
	- user-guide/advanced-configuration/exporting-environment-variables-to-containers.md
	- user-guide/advanced-configuration/csrf-cookie-secure-setting.md
	- user-guide/advanced-configuration/session-cookie-secure-setting.md
	- user-guide/advanced-configuration/extra-settings.md
	- user-guide/advanced-configuration/no-log.md
	- user-guide/advanced-configuration/auto-upgrade.md
	- user-guide/advanced-configuration/service-account.md
	- user-guide/advanced-configuration/labeling-operator-managed-objects.md
	- user-guide/advanced-configuration/pods-termination-grace-period.md
	- user-guide/advanced-configuration/disable-ipv6.md
	- user-guide/advanced-configuration/mesh-ingress.md
	- Troubleshooting:
	- troubleshooting/debugging.md

Please see the README.md under docs to know how to build docs locally: https://github.com/ansible/awx-operator/tree/devel/docs

[YaronL16]

Thank you @kurokobo

Honestly after looking into it I don't think it belongs in the Operator docs, but in the regular AWX docs, as seen here:
https://ansible.readthedocs.io/projects/awx/en/latest/administration/custom_rebranding.html
I don't mind adding the page if you think it can be useful, but I don't see how it's relevant to the Operator.

[kurokobo]

@YaronL16
Okay so let me explain why this issue is on Operator repo instead of AWX repo.

AWX has two logos; logo in the login screen, and the header logo(top-left corner on the UI). Indeed the users can change the login logo via UI as you've stated, but currently there is no UI to change header logo.

But technically we can change the header logo by overriding logo image by mounting new image on the specific path in the web pod by AWX Operator. Also in the same way, the login logo can also be replaced without any UI work.

There is already documentation for replacing favicon in this manner: https://ansible.readthedocs.io/projects/awx-operator/en/latest/user-guide/advanced-configuration/custom-volume-and-volume-mount-options.html#custom-favicon

If you want to continue to work on this Issue, instead of adding a new page, it would be sufficient to simply add a “CUSTOM LOGOS” section to the above page. First of all you should find the paths for logos to be overridden 😃

[YaronL16]

@YaronL16 Okay so let me explain why this issue is on Operator repo instead of AWX repo.

AWX has two logos; logo in the login screen, and the header logo(top-left corner on the UI). Indeed the users can change the login logo via UI as you've stated, but currently there is no UI to change header logo.

But technically we can change the header logo by overriding logo image by mounting new image on the specific path in the web pod by AWX Operator. Also in the same way, the login logo can also be replaced without any UI work.

There is already documentation for replacing favicon in this manner: https://ansible.readthedocs.io/projects/awx-operator/en/latest/user-guide/advanced-configuration/custom-volume-and-volume-mount-options.html#custom-favicon

If you want to continue to work on this Issue, instead of adding a new page, it would be sufficient to simply add a “CUSTOM LOGOS” section to the above page. First of all you should find the paths for logos to be overridden 😃

Hi @kurokobo , thanks for the clarification, that cleared it up.
Just submitted PR #1840.
Please let me know if there's anything that needs changing