Skip to content

Docs: Local development guide is confusing and incomplete #1380

@AshvinBambhaniya2003

Description

@AshvinBambhaniya2003

Description

The current contributor guide for setting up a local development environment (docs/contributor/code-contribute.md) is confusing and can lead to a frustrating onboarding experience for new contributors.

The Problem

When a new contributor follows the Run KubeVela Locally guide, they perform the following steps:

  1. make core-install
  2. make def-install
  3. make core-run

This process appears to succeed, but it results in an incomplete KubeVela environment. Specifically, essential in-cluster resources like the kubevela-vela-core ServiceAccount and its associated RBAC permissions (ClusterRole, ClusterRoleBinding) are never created.

The only reason the local controller runs without error is that it falls back to using the user's personal ~/.kube/config file, which typically has administrative privileges. The documentation fails to explain this critical detail.

This leads to several problems:

  • Confusion: Contributors are confused when they cannot find the expected ServiceAccount and other resources in the cluster.
  • Unrealistic Environment: The development environment does not accurately reflect a real production or CI/CD deployment, where the controller relies on its ServiceAccount for permissions.
  • Incomplete Instructions: For a more complete setup, the guide refers to the Debugging Locally with Remote KubeVela Environment section. However, this section is also missing a key prerequisite: it assumes KubeVela is already installed via Helm but does not provide the command to do so.

Suggested Improvement

The documentation should be updated to:

  1. Clearly explain the limitations of the "quick start" make core-run method.
  2. Provide a clear, self-contained, and complete set of instructions for setting up a realistic development environment that includes all necessary resources (CRDs, ServiceAccount, RBAC, etc.).

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