Add installation/backup/restore to docs - #770
Open
ssimpson89 wants to merge 5 commits into
Open
Conversation
The docsite linked upstream ansible/awx-operator for install, migration, upgrade, and uninstall, and referred to the AWX Operator documentation for mesh ingress, custom receptor certs, and private registry EEs. All four doc paths exist at the same locations in ctrliq/ascender-operator on devel. The readthedocs links become GitHub links because ascender-operator has no published docs site yet. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
The docsite had no installation section. index.rst carried no entry, quickstart/setup.rst is the Settings page, and quick_start.rst told the reader to install Ascender without a link. The only install content was a single line on the Starting, Stopping, and Restarting page. Adds an Install section covering the ascender-install path and a manual Kustomize install of the operator and the Ascender resource, and points the quickstart at it. The manual page follows the resource that ascender-install generates, so it includes postgres_data_volume_init for root-owned volumes and CSRF_TRUSTED_ORIGINS, both of which a bare operator install needs. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Two commands were wrong. The operator deployment is awx-operator-controller-manager, not ascender-operator-controller-manager: config/default/kustomization.yaml sets namePrefix awx-operator- and that is not renamed downstream. And init_postgres_extra_commands is not a CRD field, so the API server silently prunes it; postgres_data_volume_init alone gets the documented behaviour. Also: k8s_platform defaults to eks rather than k3s, eight platforms ship rather than seven, host support includes Ubuntu and Debian, offline covers DKP, the installer disables firewalld, and two more operator-generated secrets exist than were listed. Puts Install ahead of Get started so the quickstart no longer points down the sidebar, and renames the K3s page so it does not collide with the existing Quick Start. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
There was no backup and restore page and no TOC entry for one. The three places it was mentioned all described the Tower-era setup.sh, which Ascender does not ship, so a customer looking for how to back up found a feature blurb promising it was easy and a command they could not run. Adds a backup and restore page covering the ascender-install path, the AWXBackup and AWXRestore resources behind it, and restoring onto a new cluster after losing the old one. States what a backup does and does not contain, since the projects volume is in neither, and that backup silently captures nothing when the database is external. Removes common/setup-playbook.rst, which documented installer tarball flags that do not exist, and corrects the overview blurb and the setup.sh -k procedure in secret_handling. Also points the install and upgrade links on init_script at the new installation section rather than at GitHub. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Adds missing installation and backup/restore documentation to the Ascender docsite, shifting guidance away from the legacy setup.sh playbook content and toward the Ascender Operator + ascender-install workflows.
Changes:
- Introduces a new Installation section (local K3s quick start, installer-based guide, and manual/operator + Kustomize install).
- Adds a new Backup and Restore administration page documenting both installer-driven and manual
AWXBackup/AWXRestoreapproaches. - Updates various docs to reference
ctrliq/ascender-operatorand removes stalesetup-playbook.rstcontent.
Reviewed changes
Copilot reviewed 16 out of 16 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/docsite/rst/index.rst | Adds top-level “Install” toctree entry. |
| docs/docsite/rst/installation/index.rst | New installation section landing page + toctree. |
| docs/docsite/rst/installation/quick_start_k3s.rst | New single-node/local K3s quick start instructions. |
| docs/docsite/rst/installation/install.rst | New installer-focused installation guide (platforms, upgrading, config pointers). |
| docs/docsite/rst/installation/manual_install.rst | New manual operator/Kustomize installation guide with example AWX spec. |
| docs/docsite/rst/administration/backup_restore.rst | New backup/restore guide using installer or manual AWXBackup/AWXRestore. |
| docs/docsite/rst/administration/index.rst | Adds backup/restore page to admin guide navigation. |
| docs/docsite/rst/userguide/overview.rst | Updates overview to point backup/restore guidance to operator-based docs. |
| docs/docsite/rst/upgrade_migration/upgrade_considerations.rst | Fixes ref formatting, adds backup/install guide refs, removes setup-playbook include. |
| docs/docsite/rst/quickstart/quick_start.rst | Links quick start to new install/local quick start guides. |
| docs/docsite/rst/administration/troubleshooting.rst | Updates wording to refer to Ascender Operator. |
| docs/docsite/rst/administration/secret_handling.rst | Updates secret handling guidance to Kubernetes/operator model. |
| docs/docsite/rst/administration/performance.rst | Updates operator documentation link to Ascender Operator. |
| docs/docsite/rst/administration/instances.rst | Updates AWX Operator doc links to Ascender Operator equivalents. |
| docs/docsite/rst/administration/init_script.rst | Replaces upstream install/upgrade links with local refs / Ascender Operator links. |
| docs/docsite/rst/common/setup-playbook.rst | Removes stale setup playbook documentation. |
Suppressed comments (1)
docs/docsite/rst/installation/manual_install.rst:110
- This YAML example has an invalid structure for
extra_settings: the list item is currently aligned withextra_settings:instead of being nested under it, which will fail if users apply it.
extra_settings:
- setting: CSRF_TRUSTED_ORIGINS
value:
- https://ascender.example.com
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Contributor
|
A few copilot comments to fix, then will merge this. |
cigamit
added
the
Needs triage
Signed-off-by: Stephen Simpson <ssimpson89@users.noreply.github.com>
Contributor
Author
Done! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
SUMMARY
The docsite had no installation section and no backup and restore page. This adds both sections, covering the
ascender-installpath along with the manual Kustomize andAWXBackup/AWXRestoreequivalents, and removes the stalesetup.shcontent. Operator links throughout now point atctrliq/ascender-operatorand the new local pages rather than upstreamansible/awx-operator.ISSUE TYPE
COMPONENT NAME
ASCENDER VERSION