cloudnative-pg / cloudnative-pg/cnpg-i-hello-world
Issue: Missing setup instructions for CNPG-I plugin development
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 5
- Forks
- 12
- PR merge metrics
- No merged PRs in 30d
Description
While following the README to bootstrap and run the CNPG-I plugin, I encountered several missing or unclear setup steps that can block new contributors or users unfamiliar with the environment. These should be documented for a smoother experience.
Problems faced:
-
make was not available by default; needed to install it manually.
-
The kustomize CLI was also missing and required separate installation.
-
A mention of needing kubebuilder or controller-gen would help for schema generation or CRD updates.
-
No instructions were given about ensuring the cert-manager and CNPG operator pods are fully ready before applying the plugin manifest.
-
The manifest.yaml file was not directly available unless release artifacts were built manually clarifying that or pointing to an example would help.
Suggested Fixes:
-
Add a "Prerequisites" section in the README listing required tools (make, kustomize, kubectl, etc.) and links to install them.
-
Add a step to wait/check for CNPG and cert-manager readiness (kubectl rollout status) before plugin deployment.
-
Clarify where/how to obtain the manifest.yaml (either via GitHub Actions or building locally).
-
Optional: Link to common errors and troubleshooting steps for known gotchas.
I'm working on this and will open a PR shortly with the changes.
Please feel free to suggest improvements once it's up.
Contributor guide
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 the README and compare its bootstrap and deployment steps against the listed gaps: make, kustomize, kubectl, kubebuilder or controller-gen, dependency readiness, and manifest.yaml availability. Check how GitHub Actions or local builds produce the manifest. Done means the README has prerequisite links, readiness checks, and a clear path to obtain or build the manifest, with troubleshooting guidance where useful.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go, kubernetes
- Domain
- devops, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- Half a day
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100