redhat-et / redhat-et/docsclaw
Consolidated OpenShift deployment guide
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 2
- Forks
- 1
- Avg merge
- 6h 9m
- Merged PRs (30d)
- 1
Description
Summary
Deployment knowledge is scattered across multiple files:
docs/demo/README.md— demo walkthroughexamples/nps-explorer/README.md— NPS-specific deploy stepsexamples/skill-playground/README.md— playground-specific stepsdocs/demo/image-volume-scc.yaml— SCC for image volumesdocs/demo/llm-secret.yaml— LLM secret template
A new user has to piece together information from all of these to
deploy an agent on OpenShift. The SCC setup is a recurring pain point
that trips up anyone starting in a new namespace.
Proposed
Create docs/openshift-deploy-guide.md covering the full path:
- Namespace setup — create project, set context
- SCC configuration — when needed (image volumes), how to apply,
which ServiceAccount to bind - LLM secret — provider options (Anthropic/OpenAI/LiteLLM)
- Agent deployment — ConfigMap, skills, Deployment, Service, Route
- Verification — health check, test request, a2a CLI
- Troubleshooting — common issues (SCC denied, missing secret,
image pull errors, timeout on LLM calls)
Depends on #80 (simplified args make the deployment steps cleaner).
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with docs/demo/README.md, examples/nps-explorer/README.md, examples/skill-playground/README.md, and the YAML templates in docs/demo/. Use issue #80's simplified arguments when structuring the deployment steps. Done means docs/openshift-deploy-guide.md covers namespace, SCC, secrets, deployment, verification, and troubleshooting without requiring users to piece together the existing files.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- yaml
- Domain
- devops, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 68/100