Skip to content

Issue: Missing setup instructions for CNPG-I plugin development #184

@DevAnuragT

Description

@DevAnuragT

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions