cidrblock/apme-rhdh-dev

Profil cidrblock

Dernière activité source enregistrée: 30 juillet 2026 à 16:39

Catalogue SkillsMP mis à jour: 17 octobre 2026 à 00:09

skills collectés: 1

Étoiles GitHub: 0
Forks GitHub: 0

README du dépôt

Fichier source du README : README.md

Lire le README source

Afficher le README complet

# APME + RHDH Local (developer loop) Test and develop Ansible Automation Portal **APME** dynamic plugins against a local [RHDH Local](https://github.com/redhat-developer/rhdh-local) instance, with the APME Gateway running in a Podman pod (`tox -e up`). This is **not** a full Portal / OpenShift substitute. Use it for: - Loading APME + self-service as RHDH dynamic plugins - UI work against a real Gateway on `:8080` - Validating export / `pluginConfig` wiring before Helm/OCI **Agents:** follow [`.cursor/skills/apme-rhdh-local/SKILL.md`](.cursor/skills/apme-rhdh-local/SKILL.md) (and [`AGENTS.md`](AGENTS.md)). Ask Cursor to use the **apme-rhdh-local** skill when standing this up. ### Pick your loop | Goal | Command | |------|---------| | **Everyday APME UI** (fastest — HMR) | Gateway up → `make react` → http://localhost:3001 | | **UI inside real RHDH** as a dynamic plugin | `make sync` (once) → `make up-dev` → edit → `make sync-dev` → refresh | | **Full export / ship-shape check** | `make sync-restart` | --- ## Happy path (other machines too) ### Prerequisites | Tool | Notes | |------|--------| | Podman (or Docker) + Compose | Same as [RHDH Local](https://developers.redhat.com/blog/2025/03/31/rhdh-local-test-develop-locally-red-hat-developer-hub-using-containers) | | Podman socket (Podman users) | `systemctl --user enable --now podman.socket` — required for `podman compose` | | Node.js **20 or 22** + Corepack/Yarn | For plugin export (`rhdh-cli`) | | git | | Sibling checkouts (defaults — override in `.env`): | Path | Repo / branch | |------|----------------| | `$HOME/github/ansible-backstage-plugins` | [ansible/ansible-backstage-plugins](https://github.com/ansible/ansible-backstage-plugins) @ `feat/apme-eap-next-ui-workflow` | | `$HOME/github/rhdh-local` | [redhat-developer/rhdh-local](https://github.com/redhat-developer/rhdh-local) | | `$HOME/github/apme` | APME engine (for `tox -e up`) | ### One-time setup ```bash git clone <this-repo-url> ~/github/apme-rhdh-dev cd ~/github/apme-rhdh-dev cp .env.example .env # edit paths if your clones are elsewhere systemctl --user enable --now podman.socket # Podman users make setup # clones rhdh-local if missing; wires configs ``` ### Every day — React UI (default for most APME plugin work) ```bash # Terminal A — APME Gateway (real scans) cd ~/github/apme && tox -e up # Terminal B — monorepo app with HMR (ports 3001 / 7008 — not native :3000) cd ~/github/apme-rhdh-dev make react # → http://localhost:3001 ``` Wait until the log shows `Listening on :7008` and plugin init completes (not just the FE). Sign in as **Guest**, then: - Git Repositories: http://localhost:3001/self-service/repositories/catalog - Content Quality: http://localhost:3001/self-service/repositories/quality - **Add repository:** http://localhost:3001/create/templates/default/apme-register-git-repository (needs the seeded Template — restart `make react` after pull so catalog loads it) - **Skip Add:** Catalog → seed entities (**ansible-lightspeed** or **terrible-playbook**) → **Quality** tab Do **not** use `/apme` in `make react` mode (legacy redirect; often 404). ### Every day — RHDH Local (dynamic plugins) ```bash # Terminal A cd ~/github/apme && tox -e up # Terminal B cd ~/github/apme-rhdh-dev make sync make up # or make up-dev for the FE --dev loop (below) ``` Open **http://localhost:7007** → sign in as **Guest**. APME Quality UX (prototype): - Fleet / catalog: `/self-service/repositories/catalog` - Quality overview: `/self-service/repositories/quality` - Per-repo: open a Git repository entity → **APME** / Quality tab ### FE inside RHDH without recreating containers ```bash make sync # once (backends + baseline into local-plugins) make up-dev # start RHDH with dynamic-plugins-root + initial FE export # edit plugins/backstage-apme … make sync-dev # re-export FE only # hard-refresh the browser — no make up ``` Optional: `SYNC_DEV_PLUGINS="backstage-apme self-service" make sync-dev` Stop RHDH: ```bash make down ``` --- ## What `make` does | Target | Action | |--------|--------| | `make setup` | Ensure `rhdh-local` exists; copy compose/app-config/plugin overrides; create `.env` | | `make react` | `yarn start` in `PLUGIN_REPO` on **:3001** / backend **:7008** (avoids native APME `:3000` and RHDH `:7007`) | | `make sync` | `yarn export-dynamic` → `rhdh-local/local-plugins/` | | `make up` | Start RHDH Local (full install-dynamic-plugins path) | | `make up-dev` | Start RHDH with `compose-dynamic-plugins-root` + initial `sync-dev` | | `make sync-dev` | `export --dev` FE into `dynamic-plugins-root`; refresh browser | | `make sync-restart` | `sync` + `up` (full recreate after plugin changes) | | `make down` | Tear down RHDH Local containers | | `make restart` | Restart rhdh (app-config only) | | `make status` | Paths / Gateway / compose mode | After **app-config only** changes: `make restart`. See also [RHDH Local plugins guide](https://github.com/redhat-developer/rhdh-local/blob/main/docs/rhdh-local-guide/plugins-guide.md). --- ## Layout ``` apme-rhdh-dev/ ├── README.md ├── AGENTS.md # pointer for coding agents ├── Makefile ├── .env.example ├── .cursor/skills/apme-rhdh-local/ # Cursor skill: get up and running ├── docs/ │ └── user-stories/ # pointer → EAP branch docs/user-stories ├── configs/ │ ├── dynamic-plugins.override.yaml # enable APME + self-service │ ├── app-config.local.yaml # apme.baseUrl + catalog template (RHDH) │ ├── app-config.react.yaml # ports 3001/7008 for make react │ └── compose.override.yaml # host.containers.internal + no Lightspeed ├── catalog/ │ └── apme-register-git-repository/ # Add repository scaffolder template └── scripts/ ├── setup.sh / sync-plugins.sh / start.sh / start-dev.sh ├── sync-dev.sh / react.sh / stop.sh / restart.sh / status.sh └── lib.sh ``` Configs (and the APME catalog template) are **copied** into `rhdh-local/` on `make setup` / `make sync` / `make up` so this repo stays the source of truth. --- ## Configuration `.env` (from `.env.example`): | Variable | Default | Purpose | |----------|---------|---------| | `PLUGIN_REPO` | `$HOME/github/ansible-backstage-plugins` | Source of dynamic plugins | | `RHDH_LOCAL` | `$HOME/github/rhdh-local` | RHDH Local checkout | | `APME_BASE_URL` | `http://host.containers.internal:8080` | Gateway as seen **from** the RHDH container | | `COMPOSE` | `podman compose` | Or `docker compose` | | `SYNC_DEV_PLUGINS` | `backstage-apme` | FE plugins for `make sync-dev` | | `REACT_PORT` | `3001` | Frontend for `make react` (see `configs/app-config.react.yaml`) | | `REACT_BACKEND_PORT` | `7008` | Backend for `make react` | `host.containers.internal` is the Podman host gateway. Docker Desktop usually works with `http://host.docker.internal:8080` — set `APME_BASE_URL` accordingly. Plugin config key is **`ansible.apme.*`** (not top-level `apme:`). Verify Gateway on the host first: ```bash curl -sS -o /dev/null -w '%{http_code}\n' http://localhost:8080/docs # expect 200 ``` --- ## Troubleshooting | Symptom | Fix | |---------|-----| | Plugins missing in UI / Quality tab gone | `make up` (clears cached `ansible-*` installs — RHDH installer GC bug after sync-restart). Check Scalprum lists `ansible.plugin-backstage-apme`; hard-refresh + Guest login. | | APME calls fail / connection refused | Confirm `tox -e up`; curl `:8080`; set `APME_BASE_URL` for your runtime | | `rhdh-cli: command not found` | Use Node 20/22; `cd $PLUGIN_REPO && yarn install` | | Wrong branch | `cd $PLUGIN_REPO && git checkout feat/apme-eap-next-ui-workflow && git pull` | | Port 7007 busy | Stop other RHDH Local / change ports in `rhdh-local` compose | | `failed to connect … podman.sock` | `systemctl --user start podman.socket` then `make up` again | | Blank white page | Use **http://localhost:7007** (not `127.0.0.1` — CORS). Hard-refresh. Usually duplicate API factories — our override avoids `dynamic-plugins.default.yaml` and does not register both GitRepos factories. Re-run `make up`. | | Sign-in page only | Click **Guest → Enter** | | Home 404 | Expected if DynamicHomePage failed to install; use **Catalog** or **/apme** / **/self-service** | | `apiRef{ansible}` on Self-service | Ensure `AAPApis` is in self-service `apiFactories` (see `configs/dynamic-plugins.override.yaml`) | | Template `apme-register-git-repository` 404 | `make up` after latest configs (catalog location + scaffolder module). Wait ~30s for catalog refresh, or check Catalog → Templates. | | **RH AAP “Login failed, popup was closed”** | Self-service **Create** always calls AAP OAuth. This loop sets `ansible.apme.useStockCreateForRegister: true` so **Add repository** uses stock Create (no popup). Or open seeded Catalog entity **ansible-lightspeed**. Manual URL: `/create/templates/default/apme-register-git-repository`. Do **not** set empty `GITHUB_TOKEN=` (Backstage rejects `""`). Needs a `backstage-apme` build that supports that config key. | | RepoUrlPicker / GitHub empty | Type owner/repo manually, or add GitHub OAuth (RHDH Local GitHub guide) / real `GITHUB_TOKEN` then `make up` | | Catalog stuck 503 / empty-string token | Remove `GITHUB_TOKEN=` from `.env` / `rhdh-local/.env`, then `make up` | --- ## Out of scope (use Helm / Portal) - AAP OAuth / production auth - Portal RBAC - Operator `ociPluginImage` install path Those stay on OpenShift + the [Helm chart developer guide](https://github.com/ansible/ansible-rhdh-plugins/blob/main/docs/guides/helm-chart-developer-guide.md).

Chargement du README du dépôt…

Skills dans ce dépôt

Développeurs de logiciels

1 catégories métier · 100% classifié

skill

métier

description

mis à jour

apme-rhdh-local

Développeurs de logiciels

Stand up and operate the APME + RHDH Local developer loop (dynamic portal plugins against a local APME Gateway). Use when the user opens apme-rhdh-dev, asks to run APME in RHDH Local, sync/export portal plugins, make react / up-dev / sync-dev, fix blank page…

Langue du texte source : anglais

2026-07-30

Affichage de 1 skills collectés sur 1.

Installer avec un assistant IA

Copiez ce prompt dans l’assistant IA que vous utilisez.

Follow https://skillsmp.com/skill-install/prompt.md to install Agent Skills from https://github.com/cidrblock/apme-rhdh-dev.